{ "item": [ { "id": "d4db05b9-a740-4766-a48a-e2252fef9416", "name": "Affiliate", "description": { "content": "Affiliate endpoints.", "type": "text/plain" }, "item": [ { "id": "900dc183-31dc-4bab-8c57-c6470330e43a", "name": "List Affiliates", "request": { "name": "List Affiliates", "description": { "content": "Retrieves a list of Affiliates", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `id` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `name` - Wildcard matching allowed\n- (String) `contact_id`\n- (String) `referral_contact_id`\n- (String) `status`\n- (String) `code`\n\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" }, { "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": "71625570-b312-4516-8c2b-56dc8b434a1b", "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": "1ef8d5f0-2ae3-4aff-b515-8bb7b69ade2a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da96b8ba-d526-44e2-adfd-4fbbaf8aa881", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec915a6b-38ce-49c9-a026-6bcc32abf384", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bfb0f2c-bcef-4cf6-898d-56e5e3e6b1b5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "574869be-eb1c-45c3-8f17-fe046bf2e8fb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "120a739c-f6f2-4de4-baf3-5f8a055f42ad", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ba8188a-b797-4557-a705-c0a87a280f55", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef65bbd0-55b9-45b4-b21b-0437adeb3bdd", "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": "9682f06e-a8b4-4d42-864b-629a26c3b6b2", "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": "724d5096-5f00-451c-8aa7-f6f88daf73a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39cfc8a3-8aaf-4db2-b261-c8a6c476aac5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0734caf4-8526-4141-82ec-e52dc667d5da", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afdd44d9-6d56-4582-8e8a-6c51077d3e8d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f24646-e796-4a29-9ea5-c6626515c0df", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd4cae3-0b7c-46d7-9a7e-79c52b2a81dc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee33c8f5-bb0f-4560-aa1d-09a898c21260", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afabbcbe-8a3a-4735-82df-37d58ac5f444", "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": "b81905df-e39d-49de-9521-27bca17607ce", "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": "bbd5da17-8566-46be-81fe-ad7e4aa08392", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b3338a3-a881-47dc-8cbf-cab238280f54", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3e1cc96-fae0-43b3-a8c4-d28e9befcc60", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d1c9e1-e71b-4676-99b3-750c29125746", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d96010d-dc0b-42d7-aedd-8e07afa73025", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4ecd958-17b6-4e51-8b72-20e804597a92", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17c75364-bd3c-42bf-adb5-6ad3b20b7200", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85ee0b24-7558-46b4-b161-0ef26987cffc", "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": "b38ba4d9-ba31-4eac-be9f-556e85adfef6", "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": "3244d25f-db9d-4bd2-bfae-5ee7d75c9769", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e00746ff-92f9-49bc-8821-db9aef6fed7c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4116cc59-5c8d-4860-81a6-6784d75b4719", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f4798b8-1339-4db1-901f-84d85ac89d75", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a17508ca-20f5-48b2-9510-722c4f921874", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff571c05-5d52-4cce-bad1-4b2effd93a76", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d805634d-de2c-44eb-a4c2-032e09b8a777", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2be6e5f5-3a12-49f8-9b4c-a992b5a62009", "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": "9503e7ce-c228-4f5f-a2f0-a16918236576", "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": "1627ebea-2036-43d8-834f-58880d9dc6a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "825d54be-9568-42ea-82f2-a98f372bd859", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e57757a1-e745-4da6-b431-116f875b95f9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29ada32c-0d8a-4595-b238-346e94dea1d8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c64977-36a3-4242-8049-03201801cef9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb700387-f2c9-4fcb-a81d-96d1d94a8bcd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb63ce7b-79ba-43b5-bcfa-99873485048f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10f1aef0-8f59-43a5-bfb3-7263e7ec98e6", "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": "3ab247bc-a488-4a96-b825-68eaf115ac70", "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 \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"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": "a823a9c8-ac02-40eb-8cc0-13592d5f11a6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2d43d10-70ed-4f64-906b-ef1722be3534", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a09c40c-d8d7-4450-a686-5a75832ae591", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4e52aad-9fbc-4ddf-95d2-0028783820ce", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "030605b0-8ae8-48e7-953b-018867c9f30d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15bd6eeb-c4af-40ab-af88-0048c4906e4c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7c9f37a-1fbf-4cc7-ae5e-289d77acea28", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00e2d109-0002-4f31-9648-c5e367479f4e", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "1cb1fcf4-1ee9-46e9-a0cf-b87340f4f4c7", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fe4fa73-99f5-4e89-b28f-aedeb2c94ad5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0a41d29-04f8-4c91-84fd-30500cb661f1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f220c215-9d44-4bdf-a374-73f2cb70c9ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7186628e-dd6a-4074-80a2-46a06c46d17e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c71f0fc-cdee-41df-b587-ac4f99d09560", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fbba8a8-625b-40d0-9037-420e9a55efb8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "070b0c18-df68-4a4a-8e19-cbec7b9d678d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0c7ba96-189b-47dd-9e22-865057648289", "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": "0a7837b0-7f85-4681-8ba0-a0e00e814c4b", "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": "845ff772-0ebf-4fb3-9c32-3eb06aa432b9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9285c74d-2163-454b-9f11-79c3da93b829", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2994ce18-312a-49fa-a208-9bad266a4b74", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32efc472-7d39-4bee-9b53-6c7be56f750a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c567221-611a-44d8-8b42-3dc4a71c34f1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23b39168-b0a9-497a-a174-3eb7ac62095b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77174aff-fea2-4b61-87b5-72e32e2c5a14", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61de32eb-d8e8-49e1-9118-9ac8543531eb", "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": "ed1218c0-7da0-4157-8dc5-6e4a0217bf92", "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": "e4fdd82b-cd80-418e-b425-981ca049ed6b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaee1a6e-c22a-464d-b826-d48b2ea6365c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e06e06d-b85a-4ea5-befa-20b9681044f8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf91e223-2a42-431f-b54c-76040e9894e8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d00dea98-df4b-4640-a6ad-bf661914b357", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76400a15-360c-4b5d-8695-0befbdf70213", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c432c7-00a6-4171-947f-f6c6babe6891", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a66f200-07a0-4a28-9055-7057b02a13bc", "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": "9f82f83b-b71c-44e6-81e7-8e33c783cad2", "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": "e29e0c66-688b-40f7-9b38-48fecd3c539d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fa20782-6fd9-4c03-9fd0-dc7e197f22eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "341c4626-9fa6-4d27-86ab-75c5216de966", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22c3ea17-84a1-4657-8330-bb227fcdcf29", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5273fd04-b461-4dcf-9d38-99806cdd4d3a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10031848-1097-4ca6-a3dd-1249a8087283", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "735a1bda-0e4c-4bc0-b38c-b275e7d5c73d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92474f2a-dcce-478b-8b2b-49b48c349548", "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": "718aded0-47aa-4b1c-b8b1-d4ac87692ccd", "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": "07883f02-a3a7-4996-ae4f-ae1b127832ce", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95bef9fc-f05a-4a4b-a676-deec2a4c4675", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3c396db-0aa5-44df-b535-b4da787dc76a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2186dde2-3854-4980-a53e-0d95a201017d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28ee7169-343a-4aeb-a61d-baa8903b8863", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f16796-9e9a-4e15-aa34-28489f94cd9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a955fc8-8d87-4e88-995d-dca1cfdec0bb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ecc80ba-9a85-467d-bf15-ba027fd830bd", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1bff26ac-00c2-4d33-8d20-ef3cff0b169b", "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 \"dollar_amount\": \"string\",\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 \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7adea321-eab7-4d13-8598-33806a736224", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e38c4f30-28c4-48fd-b684-12de264df089", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63671ec2-b2e0-4866-998e-ddcbd80aa540", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3645af83-3dcb-43d7-9331-1a085de4626a", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c7e5c66-2e54-4faf-832d-fa1f7a241370", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71cf0293-78ff-4279-b56d-0f407da4b128", "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 \"dollar_amount\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77f7ae7f-bb60-41f3-8fbd-503696a0156f", "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "324bf737-343f-4dd8-86c8-74eb8de53360", "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": "string" } ], "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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2bdd5e05-2092-4501-ae84-959e3406f6c6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\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 \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d047a5e-492e-4e5c-9fe5-0e69373211a5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7828f0a-f8e7-4c56-9f8c-1ba739ecccdc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f185dd8-d186-4a32-90ad-20860018c4d1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "440c3039-3cc9-4aaf-a863-d9544832836b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36afa1e2-d427-4a2a-a093-fde9963776c9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4355cf-0851-4cb9-96aa-751be42476b7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27275102-da52-40f4-8d57-6142dc8a4c5b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0065a94-6bef-4ae4-88a7-0e279d1f0f00", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "45a658ae-9148-412c-a82c-e8f9e9dfa833", "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 \"dollar_amount\": \"string\",\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 \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f08fa88-1b97-4b87-b564-c84f7ad55b38", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d128797-4b5c-4042-92b9-a8d4446bef04", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8726b842-14e0-4bce-9cb4-b18635a08c14", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01213330-9d09-4367-a471-e0c9927975e5", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f3b3bd2-5262-4947-b511-d5f5ca7479e4", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa43c789-6659-4f1a-a251-1c97381acd6f", "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 \"dollar_amount\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0a08282-5112-4975-bb72-845632026ece", "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 \"dollar_amount\": \"string\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "092ce8ab-054c-4b78-89d8-23f6af3ffadd", "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": "string" } ], "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "46c2cf2d-3fd5-4269-9ca8-e2b5dbdfe7a7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1720f823-0598-492f-984b-1b02c9b9000b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc648000-9d63-4e42-b398-ad2f6c58449d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11eb6e56-ca0d-4992-953a-bb31957dc622", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "693f1112-f75b-4d68-9158-5e8baaa42d6f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "103ba933-832b-4a87-9c5c-a1a4956ceff9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7866119-acbe-4ed6-b6a1-dffba1e3e591", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09582433-e840-4fd2-9f10-731eea9aac9c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eceea211-620c-4ec6-9c09-c4bb593eb8cc", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "133b07e2-7074-45e0-8df8-912cc776550d", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33b1670-b20e-4139-be94-1cb1c47b63c0", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f21b760-6db6-4c6d-bf5f-d5ddfab77d53", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb309a8-5fbc-4b35-af79-24dfea3c3dca", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1d9a96b-1c21-4cca-ba0b-3f5c9f98445a", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83f0621-6bc1-41d6-81b6-cab134258e37", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f71b78d-4cfc-41c6-900e-cd4c64c49dcd", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f185eb-bb1e-42ee-8d10-941fcd12a400", "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6273bddf-c30a-4775-af5d-26bb8ff72477", "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": "string" } ], "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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53366e85-9d1e-4a74-ad90-61df9aaf6122", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"message\": \"Default commission set successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7091f4c-c125-4128-9cb0-c58d6a2ea630", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e97bf97-1bd3-4abe-b432-ab9dae909a9c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1debc3-251b-4937-8508-5efe0d447b60", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e75985b-63e0-4f22-b785-d367c3661105", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac5b9cc8-ed76-4e7d-b026-709e1fd13839", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10990a13-5ebb-4e09-8f06-945845c34368", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79558447-d8e5-407f-995a-e6887f215723", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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 \"dollar_amount\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "318eb0e4-dbd1-4342-8ac4-02c72360e846", "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": "7592f766-e080-4fbb-a87f-b984fb4eddce", "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": "5317e658-5c34-4eb1-a52c-38f585a1c838", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28c9b822-a0d5-45ef-abf7-3b92b2b9d5bc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7995924a-9add-4f01-94a9-4c3634146f96", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "955697f8-6185-44d7-8a0a-96e1aab4eb41", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c45e38f-a7ec-40b8-820b-6096c1d62bb2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95a817c0-099f-4f76-93ff-56d492afe82f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13ecf67-871a-432b-b521-fe518ef69477", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "703e6b5d-2873-41a5-b3c5-278843220c95", "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": "710ebe42-c797-42d8-89b4-1a0e4132e9bf", "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": "dfccc587-1d88-4dba-afa3-5f366eaa835d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf79197e-bcfa-4fdd-9f85-96b773b55c6f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19fc5fb-0dc6-4c3e-8f5f-23aa52461354", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248bcbe3-0612-48eb-ae37-09c5bd4829da", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6974c2ea-699c-479a-b4ca-f0a069ef7ae8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526923d7-4c56-4771-a590-236c265909ec", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfb1a36a-65a7-45e0-9027-2fa51102ea55", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29742dfd-3232-4f0f-8bc0-bf42152bed36", "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": [], "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": "4814d146-2be7-4cac-9223-d4f5aebba125", "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": "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": "7b2403fe-aee7-4607-89a4-775382cca0b5", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f4c0965-9a1b-4bb4-a914-ad36bcd6841e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "637819ce-4334-4ce4-9ee3-d17666bb99dc", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5dcb941-2fa4-44c5-92c6-652d9ee74a0c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a72f1a-f7cc-48fb-ad01-0f2ecdd54659", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f75c5c2c-e927-47c4-bd7c-e938f7987748", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ccc200-25a9-4995-ae46-34f42c01e323", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a52e5657-1d72-492a-9dcc-ed80e0fc5998", "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": "f2dff95d-fd78-4fb9-b015-76ec887ff453", "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 \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"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": "5b4d2d02-b5cc-4b96-bd95-15337a6c4700", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a0ae9c7-d27f-4e36-b576-6f74b2d494ae", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c951d62d-58af-4736-a374-21f3f19635f2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89810e67-af05-4c76-b9a4-3988c71b5f4f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c845b0-547b-445d-ad90-99a5e5909acb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be60e078-4cdb-4c19-9b87-4058bc291de6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93b347ab-7346-43d4-8ee7-ba25a56bb73f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f826a3a3-258e-4141-b8bd-756f14f80a14", "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": "a4c65afa-356e-4d54-ba44-e429e4c74537", "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": "99b9384f-c211-4363-9556-ebe0c783e117", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a757dff-68ea-44af-b340-1752b6f9ff2f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2916143f-1af8-4b83-a13a-312f5977d19c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00e04f0-97e5-4d80-adfe-abf898f492a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b4eaa0-151a-414a-b6a8-52f80de718fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5617d7d2-dd6a-4b13-9311-b187334bec2e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3e26be-3786-45e7-99d8-8e99d817b682", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ee7be6d-f299-48ac-90a8-eb8bcd48fad9", "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": "77a4fe8d-fac2-4af0-8cae-822c3e320483", "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 \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"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": "0243b7f7-2ce0-475d-88e2-2b3c2239cd8a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf7d9920-0c41-4da2-be66-8317e5d305d6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e688647-b775-4597-869a-db59e6232af1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf2ce136-2062-4db6-9b07-780e7ac54812", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5be8a417-e9a9-471e-afc4-b84e23bf28ef", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a4d9d0-ec79-439f-bf31-495f0d5883bb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d854e939-ad28-4be0-b914-0fbfac931091", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "920c30f3-8793-4421-9412-4369f81238b4", "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": "b1861057-9d88-4b01-be25-e0cb035372b8", "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": "167420c5-848f-4cfa-8505-18e7fa9471ef", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c3ec831-4ca7-460d-a7eb-e0a43dafc207", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684034e6-3624-4c7f-b144-5c7b55479777", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45632208-6cf1-4449-a627-408a327bdec8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e79424-1dd1-4db8-b983-e8cb9c0e0d21", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d772e937-42e8-4688-899b-ded3218e85c0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b3870cc-4a80-476a-bf42-6983c1f00ccc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ac9c16d-4320-447d-9555-0379df657063", "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": [], "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": "8e98cc20-a17d-4f42-9773-f64b6736caf4", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4effece-4b68-4b19-93d8-a38cda466476", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df45cabb-afe9-4d61-ae7b-3bd0fc0098e9", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c0ae9e5-6799-4ed2-943e-a57601a5f989", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684f1078-25c6-45f4-88df-71fe52cb41d6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d2095cf-b980-4947-b545-de5161537fb9", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db9b6c46-b690-4086-9da5-938057e47b48", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44dd1568-5d8b-4151-81dd-25e9ab4bafaa", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8addb195-df08-48ee-9745-fa9a2c109829", "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": "2ae19413-c803-4af5-be36-59402527b579", "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 \"percentage\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\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": "ecf4ddd7-dff6-4bc1-92de-791b20a7aae1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f9f9972-cc35-420a-88c8-ab7d063e3560", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b90c0a3a-8c22-4da5-a659-c28a096ee0d5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72903921-4514-40cc-b27b-632b1653c516", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "598898f9-1326-4b77-8e5a-e81fbc2004fb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f87cba5-a520-43c4-92a4-f7d75d7ac775", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da782d6a-831f-42ca-904c-0279d0437114", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0eb4922-5458-4112-89bc-0f69d3031531", "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": "875cd1a4-254c-4f8a-adba-a9a23d015547", "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": "1c554dad-3036-4be1-83b4-3d046066990e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c0555dd-9a3d-463f-8924-3dc46e3a171e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599ddc01-dbc7-4f34-ae3e-335d43f3e7ef", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5a0ff18-ec5d-4314-9ccf-7bd78e8e244b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "418fd6ed-f236-4eaa-a784-dd00ed8dde05", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de31f593-1408-43af-8204-4f949a45e816", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e13cdd88-bc7a-4d7c-bf86-9366360aa4d3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8244ef0-e80a-4393-9e3a-1322725c8923", "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": [], "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 \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a23ba5bb-10cf-4fb5-89c2-db5fb4469523", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\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": "52715740-306e-4109-82ff-2d59851f2ec5", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebab0a01-d84c-49a0-9be4-d656b727751f", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a32f85-b3d9-4690-9b94-b73ea3dabbaa", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b507a4-64b8-4388-af2e-f350930d9913", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641ce1ad-b1ba-4642-ae3e-6b0c6c8a0f02", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a189ed-4015-43d2-92cd-817eef6dab2b", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c0a0734-4bc1-4e9e-9f2f-783de598b0a5", "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": "PATCH", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e2a32b7-db4e-4b45-bbda-cd5bab9a1d26", "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": "dbe329b2-02d0-4c53-ba29-e96a5e96d4fc", "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": "6d6264db-a8c3-4835-8c43-a2e9dfbb3ce8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9df295c-c266-44cd-8a38-9a3f834dd0b9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e97fc304-19c6-4707-bdba-1b5928c76672", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e81661a2-b098-4496-bf2e-f627214ef60c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a94a3bb-6d49-4a6b-85e3-742697762db0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a6d3c98-9fd0-47d8-8a6e-c5c399f61c97", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a0cb94-5efc-4258-bb0a-38997f7d1284", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15d454d5-6460-4a1e-9cd8-c38cc03aed5d", "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": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4b4c77bf-118f-40e5-b3f0-d2d818b0eb94", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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 \"referrals\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a35ea4-e87d-47a9-a0ff-75d27868c495", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6e141c7-c271-4317-900a-6d88ade11de1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bae7776-3ae8-4bc3-a2d9-d02d1a858c7a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b376fe46-1266-4480-818a-6bad18976127", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71104c50-45db-40d7-8d69-815be6e52501", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf264b32-727c-4602-a6f8-b2ed97116b5d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de73199c-5e14-4107-8590-247db516a347", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f205432-80aa-4f35-bdf7-860c6a180122", "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": "696f5633-bfe0-4c12-93bb-5f6744c2afa4", "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": "604cade4-e34e-45a3-80d4-b3600ce29b32", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38212dab-3fcf-437f-a337-3fac1dc960e3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce84f53-2287-4618-939d-8617110039cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46f56b7-eda3-497c-a2fc-bfbc2ca64dcc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86adc954-2c3b-407a-8001-c6de23102642", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba721f6e-f0c8-4aa4-b6da-a7526bb46f05", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79dafc2c-aaa2-4118-b2ba-5c161330c344", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7780acc6-bc2b-4817-ab8e-7edf922b5851", "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": "d7daa361-7c0f-432b-9046-60cbad7b18be", "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": "095a432c-1c8b-4ed3-9217-9dc46f32ea9b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4daeaa1f-7c06-4f91-8e4a-707eaa31a1f4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf3b0d57-336d-4049-9b3d-9682f2e0adea", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbb31bb6-7937-401a-9edc-651336b1231d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcb5021b-d888-4a21-a42b-de3638f4b545", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c84a1f0-cad6-4378-9c4e-997dc30f027c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "857b9826-efbd-4925-a060-70e44b85ecbc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81c9337b-0c2f-4241-83ba-597ed2693487", "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": "4b89cf87-2051-476a-afe8-2a97fd4da3a0", "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": "25dd8286-82d2-40c1-892b-9e160425484f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f8d1c05-206a-43ca-8d32-c14ecebae12e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566dffe3-19ab-4f7a-8aeb-bab46f0fb47d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c73d85c-8689-4337-b0d5-13acb40ed035", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45673526-cc45-412d-ab90-b59600739972", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa4340db-2ecf-49da-874b-82438201651f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d3d2714-3ef6-419c-a88a-41f04a3de4f2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38c16e54-300a-44ee-b01c-be218e87ed5e", "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": "893adc15-4cb2-49a0-9fe3-db9d26219f46", "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": "727923d7-e7bb-416b-86c9-6495f773b826", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d48664ae-0f29-4d83-8938-589d0687d7a3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f0c805c-65a5-4be3-8871-599f63102637", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "299cb1e0-7217-4530-b76f-656dd06ba35b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94973bd0-7578-4216-a2c7-2e877b965078", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7673bf08-4e62-4504-a834-9f6407672b71", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe774357-1473-4b49-bb2e-aa553a9d828c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a750832c-fdfd-41ce-99ec-fe727a13d1b6", "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": "96c5f49e-df53-40b3-aea5-c41518b0c5d7", "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": "f96024de-2f6a-46ab-af58-9227b3841760", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b394a75c-d1f1-4193-988a-bd0aa762ef4f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bccaac8-c147-4d12-8dca-b6cfbecc3d73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b013e39-97ea-4965-8a3b-a79854009c16", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "895368fd-92a4-4c16-ad3a-8fe68f32ae32", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "878ea689-a9b4-4d17-b2d1-1c8cefb6b34c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb1ecd4-77e3-4d32-b638-dc7e1060845c", "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\": 1508,\n \"message\": \"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": "2166b81a-1e27-406f-b48f-05fe924df065", "name": "Automation", "description": { "content": "Automation endpoints.", "type": "text/plain" }, "item": [ { "id": "9ee8a4a5-ffc1-4057-bb6a-95a81c4e3f09", "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": "8b24a65f-08e9-4ef1-8217-3c800177d67d", "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": "386fc1b8-a43f-4123-b5b8-963c54d2488a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db21c220-8a2f-47f0-845f-c42ecbf5fcf7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98f66c4-055e-47b4-8308-08bec94b5489", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2225f010-3678-4aca-9a2c-cd4b6f177f16", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbdb067-172b-4291-9cd9-e1bf38f6dc13", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89e203fa-9634-491b-a156-09c51c196c94", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18b4240d-d181-4ff5-b3c1-2e483effa1eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11955695-976b-4868-9af5-9cb408524260", "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": "479a630a-6e6e-4492-a48b-56b04a11faee", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"add_to_automation_sequence_results\": {\n \"key_0\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"ALREADY_IN_SEQUENCE\",\n \"key_2\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69c66a75-3c5d-455e-b0d9-c0df622019e1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "752fc205-1656-4517-9248-96fd21d90a73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f2b9703-8991-405a-8770-9dff7b075a62", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68335799-b1ac-4bce-b746-ae67194d8777", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78dc21cd-a989-42b6-8714-8f3fa87602cb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104d4cc0-021b-467c-9ec3-8b8feb944f7a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef67e17b-fc5f-4eda-9d8b-ec7800726ea7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c1380e3-c10a-4376-b716-101d2dcb92b4", "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": "39b453f8-d0b0-4739-ad7f-11d5e45407a0", "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": "c1576e35-d204-458d-b307-6521157d829a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33686ce2-6c17-4cbc-8ad6-5a6a1409935f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c537d939-c732-4df7-abbd-f260492ecd10", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9443ad0a-17ec-4130-b8df-e88e3fbce071", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63cdc9b3-00c8-4ce3-bf85-6590a1ef54c5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31ffef63-8655-4696-8394-d897e36ecaf5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9881b08e-9f1b-4332-8b6e-781a2b00d495", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b59da82b-e44d-4ec5-9f45-128fcb98bb63", "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": "b9c44470-65bb-409a-82ef-14f027ddc67b", "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": "e4e18d30-5fe1-42bd-855e-982eecd610a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ffec759-5c71-4324-af35-1ab056df25db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9226de16-6b0c-4b09-a77f-972335834efb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121e1ef3-c104-443a-804b-1f74bb30ccf5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81578dcc-5ca9-4090-a1d6-efe586dc83b8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1064f8f-f311-4dbf-b311-23f3cc7cfc01", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1334a764-027d-457c-9a35-d6cd99120002", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48833a32-b19e-4d51-a491-cea7d4b81ce5", "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": "2ade8162-a4bd-4529-8da7-ed7e580dc195", "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": "7b77e7d9-5d63-4636-ba33-87c1fe1c9fe4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d18778a9-b07e-468c-8707-ae26c0893b9d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "765026d7-a5f0-435d-bcb3-cdf72b55964b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e972ae5-ec1b-48da-ac45-6a0c29e884d5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e18e88e1-3f31-4880-9da5-81daa231002f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49e7edd-ecdf-4908-920d-fa8cb8ea8aa8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ad57c8-91bd-4d1e-ba61-08628d5f4e9b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3621ed7c-b6cc-4b38-af5c-d959d30a2dfc", "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- (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`. The search will look for the text anywhere in the automation name.\n\n- `filter=name%3D%3DSpring Automation`\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- `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": "cd119cf4-7a52-4e20-adff-7f7e0af7aeb2", "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\": 4976\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af2d758-217d-440b-be96-c66d8d25d7ba", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbc167c7-a949-4d99-92a2-1285a225e914", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66403d5a-ba06-4ce4-a1f3-387205caba13", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b2139a7-a158-4c57-ba7e-7b7d26582a33", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f10b9d7-9246-4670-9a31-2681cf886273", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2cc125b-117d-49c4-b9e7-5c6e7f1f3728", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e41c89-aea3-49a4-9a67-98c95ff8e0f4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c267abe1-46e1-41ea-a372-5c15c8e3f8a1", "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": "4602", "description": "(Required) " }, { "disabled": false, "key": "automation_ids", "value": "5870", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "02531869-23ab-426b-b58e-7557a051baf5", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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": "4260f707-adde-49a8-a171-e7461b780538", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1581c3fd-d6b6-4610-b412-3609b7e14711", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a2449ec-58c5-4f94-b838-eac7a115b955", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40bacb8b-404e-4181-a633-cc969b5f3c0a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e042e8b5-ea09-4801-ae9b-5d260f49782b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c642f151-5ff0-419a-b2c5-e61820c71f38", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9e8309f-a4b2-4e90-b2b2-d2c415ec07e7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "2833" }, { "key": "automation_ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7a4fc6f-4713-4536-8e00-3b30e2c1b8b5", "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": "c196e699-fea3-4ed7-924b-387423d7a05b", "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": "2306b2ef-9566-41d0-891c-e100d45b0a0b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "732058ca-e6ad-4ca4-bf44-049199dd61a6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07f4606c-8905-4c2f-ac47-a90f003c4b08", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d927acaf-8afd-4c66-a1bd-03518bd9d0c4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8864717-8dcc-42a1-91a1-4343170a94f3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5e35716-60ca-4388-a192-0c02132bb47a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4d1515b-cc4f-4ea7-a764-bebc2ec83821", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bc9c283-2580-43e4-9333-8e8c0d56a673", "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- (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`. The search will look for the text anywhere in the automation name.\n\n- `filter=name%3D%3DSpring Automation`\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- `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": "3804b865-a790-4c17-89e4-b1b7b56d9b80", "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": "aebcf4d4-9855-4b1a-9941-3328d75a2467", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd32377-d588-4437-87c7-26620894d218", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc30e436-27e1-4bcb-a899-34e502250057", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a17885-d6cb-40f7-99ec-28c8f6b7e492", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f3a17b9-9ffa-435b-a0c0-e3a4b7deb572", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b2f248-cedf-4600-b8f0-f274084e00e7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62362731-8a3c-49ae-8067-df744bcefed6", "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\": 1508,\n \"message\": \"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": "ecb791e2-e3cf-4868-bdc1-6fa757a9b94d", "name": "AutomationCategory", "description": { "content": "AutomationCategory endpoints.", "type": "text/plain" }, "item": [ { "id": "f228e4a9-5476-40fa-9f7d-eb005e5a86ff", "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": "2d75439e-41dc-448d-930d-9376ec85795b", "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": "66531d48-02bb-46f6-942c-d61dc3933a58", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5cf2749-a44a-4419-b094-8a7492768bf8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ddae73c-f510-45da-a416-c275de6a22f7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e3b3dce-b099-46cd-b1b6-d10deba89b63", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5f042c8-7c0f-4697-b4a2-2a8bc9a689fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d059302-847d-404c-89cb-6351e0467259", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83eafc5-1ffa-4926-b071-2308bc4ddee3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a94510c7-32fa-4ba8-a0db-8fe43d737366", "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": "78373fa5-4330-4603-ad5b-48b85d55a3ae", "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": "1f25fb26-1d49-40b9-819f-574b5ce117ef", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68fdb7ab-7433-4f93-b613-62d29c4a7b42", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f9580cf-bafe-4a91-b688-8f6e856070d9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d9d85a-c95c-4982-b214-aa34ad1ddd04", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4f342df-b918-4d86-aa49-aec5de97b74f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f180792b-15d2-44cb-89ba-fcc5422c3499", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45b0a7cc-f356-45aa-9470-9f90ba5132f7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61f97177-b690-4dfc-ba27-661e6a770996", "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": "4602", "description": "(Required) " }, { "disabled": false, "key": "ids", "value": "5870", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e93b0b54-9263-41dd-8aa1-64fe72f8726f", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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": "ba943fc6-b842-44f9-9f3d-4dd2eeee24e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78921e31-6e4b-4ffb-846f-fdf0ba3821d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720c1cb8-a36a-44a7-b13a-b7cbbaf367f7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07340e2b-332f-4833-89a7-16ef1aacc3d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3d4810e-da2f-42e2-a37b-53e985162284", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb8483b7-1f3e-4a73-a238-f4bfed217256", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10691d73-d931-4b2e-a280-39ad1f1a301e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "2833" }, { "key": "ids", "value": "6299" } ], "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "226f95ae-9f76-4ff2-a7c0-c80cf3d220c2", "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": "967c9f41-89fc-4c7a-93e2-d6d04dfa85da", "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": "5efe3cae-9b5e-4d21-a6ec-7ee3fd370b92", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa4b82b6-09f2-49de-8ab1-37a472c00711", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610f69c1-b2cb-4c32-93dd-f5e4709f518a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e00cf1ba-b895-47b0-ac91-8955d156cf82", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d54387-e7ca-4fee-a95c-18379a0f3e44", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a563572f-de24-4f0d-8fb1-c82377792cf6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "881e1f03-d0b9-4bb4-9350-bce9e49cbd0f", "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\": 1508,\n \"message\": \"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": "9b14ca4f-9d3d-48f5-a44f-9fcb0eaf5cbc", "name": "Business Profile", "description": { "content": "Business Profile endpoints.", "type": "text/plain" }, "item": [ { "id": "7a395246-06e5-4247-8637-8d4e78bc451d", "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": "d678737e-ea32-4a3f-a1e1-dde65076f9c2", "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": "f1599ef1-d0a1-410c-9904-a98b863230e7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cb452df-6757-46c3-808d-ab601a5f8ce6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b0848c3-5757-41b2-8832-94ba415fafd7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b7e4326-6b6f-4325-9f7a-ee6c6a43f8d7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "855f02a2-4c1b-476e-9012-a41978f296f8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b5cf19-430e-4a06-8777-c6d3f822c0f0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c230e7-e9f1-4c26-b876-dde9a7a51be1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c47a47dd-5a7f-4a0c-a8fc-f957ab1b5c40", "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": [], "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": "f77de5c8-7cda-48c6-95c4-1fd987039f18", "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": "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": "c03e9040-cda0-4ce4-a932-70bf9700685d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2819802-8b94-4beb-b487-3bba4c93024b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19632e9d-6bfe-4c78-92b8-5eca0fa06796", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd32325d-5026-4ee2-8ed4-3513cccc0635", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d12c9599-8149-4b76-b589-9bb255b33975", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed7ac84-087a-4810-8151-6a2d32358a16", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90b0a49-829a-46cb-84f4-999b69f5e335", "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": "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\": 1508,\n \"message\": \"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": "b2166912-362b-4828-8af8-1c5318a50c41", "name": "Campaign", "description": { "content": "Campaign endpoints.", "type": "text/plain" }, "item": [ { "id": "ebb45872-4b22-4abd-9111-89f5f72148ce", "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": "fa602cf1-8714-437c-9c41-819747973177", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"remove_from_sequence_results\": {\n \"key_0\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"FAILED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdbc455f-b54e-4d81-91e2-6fbee6b30598", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "384b4d29-4ed7-41e1-afe7-66472c30ca92", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79d65bc-a030-49e3-a186-c985754471b1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffaad1a6-ce92-4466-be15-8651cee18c78", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2502e4-c771-4ae8-9fd9-b401fe7cce5c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "302b35b0-9a58-4a1d-92ca-c0002986f09a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acf0d96-8d49-4472-8a0e-dcd98dfdd5a8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e1fc36b-2151-499b-b46b-685ed3055074", "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": "d809bde1-9ddf-4122-bc27-1d61a3c93bde", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"add_to_sequence_results\": {\n \"key_0\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"ALREADY_IN_SEQUENCE\",\n \"key_2\": \"SUCCESS\",\n \"key_3\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1220859-427d-474a-ba4d-5ed850e11ed0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7cbf16-498a-41f0-899f-9be954b040ba", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba48d6cc-d66d-4aaa-95fc-98a1de1ddca0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "604e499a-bb19-48a6-be93-6ac0e580a44f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d775ba2a-b420-4c81-8331-8463f6bfe64f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63cbcabe-cc37-40c3-b4ea-f0d22547a0da", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b4c48c-bcff-4e35-923f-60d5b32b3d3b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d80d3f83-b61e-43e8-810a-ef65647c2ade", "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": "7043242a-0fd6-4a84-b683-c8e167de5570", "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": "c2fdcd84-73c3-49f8-9223-78c2c09208eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc67ca39-c5d5-4f52-9aea-5653b0825127", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36c504d9-413b-4d1c-8bf0-fc7e6423e656", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "593a1aa1-cc88-4986-b230-2c0d162e0b36", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "195ce713-9ee4-467f-97d0-66a5abf3d70f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78329466-931d-4263-aff0-50817eae839f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f55cf68-c02b-4c89-946c-f29cc692bbda", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4168be16-c423-4dcb-bc7a-c5f9551af11c", "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": "244d9d50-1dbe-4ea2-b2e5-82268c106775", "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": "c47b09ad-6ac3-4bc5-bf18-8460c486d128", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c810b5-87f0-4502-84ee-5e75a7bd1f52", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e55bc48-e4db-486e-a4f9-b8e374e12a2c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15198bc7-e292-4a05-95f4-1dcbabbad3d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a60113eb-110a-4b47-834f-65290b798ab5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c38993b8-9d73-46e0-9538-040ac489c5aa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f8c9ce-71da-47ee-a4a9-37fbcc3bd28a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb100aa4-f821-4764-83bf-8aa2ee30c2d6", "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": "b3eb0b31-488b-4645-8ef5-6cd349726eb9", "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": "fe42010b-97d8-4988-9473-75899ea933d5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec33977b-649d-454b-ae52-57dbe74d1e89", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dee537a-6b8f-4719-b2cc-fdf1d6b61846", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9281de5-1362-466f-b49e-18c4f32d6a39", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "741d53c3-a8f4-48fc-9b99-45deed37d728", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9849032-6915-4874-9ab7-20d996f64c1a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f5ae7e6-7d67-405f-ada7-5494e5727c15", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4bdfa33-1653-4602-bb3a-5b04af2f1cb5", "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": "2670779b-6362-4457-a91e-1170a40eaf35", "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": "30a9b77c-4666-4384-b177-0c36df36969e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a4ca310-99b1-4d0f-8beb-d0def05f6808", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "389c8474-19b0-4138-acfa-ffbfebb919e0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac95708-e4b3-4153-b4ad-209b9ded03c0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "880a2361-8f8f-4dac-b8d8-70c7960d348b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7fbf92-0116-45bb-9075-4e74974d7ab9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "345c9fdd-031f-42e9-8dcd-21818210152e", "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\": 1508,\n \"message\": \"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": "077a100b-ed92-4ef4-bbdb-5f8cf02c2ba1", "name": "Category Discounts", "description": { "content": "Category Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "2cdea508-03c2-438d-9bb9-3b854b4e9340", "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) `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" }, { "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": "dcb383f4-c617-490c-b625-64e14377f85c", "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": "8e95b616-44e3-47f6-9101-00866b0bec1c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d63f254-967c-493e-9d39-4036a4f20b75", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0cd06bd-474e-4176-b629-9e43817d7877", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fadb29c7-fa3b-463d-9b59-18316ce60a8d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24ee6f2-4c1e-42d8-91fd-feafe9dbd090", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28c933c8-7553-4936-9ec4-05736f92eacd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f2abff-8bfa-4e75-8b0e-fe4973be124f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef924d36-3ea8-41ce-ab5f-5c93a423c419", "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": "f64fe7b7-ddf9-459f-a0be-95071c25a159", "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": "208afe55-e65d-4f46-8d04-85fbc167fe96", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa8ee40-86c2-463b-97d1-c992c57d2622", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1106a89-5445-43a5-8367-5dcad7bca1fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "784a6657-1c77-4f2c-a39b-00841ee09e01", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffbd23a7-749a-48f2-8af1-b52412e0a686", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd9c122b-4e9b-4835-8b45-247d07af7905", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b82516-dc4e-4279-9fd4-d1bb59560d85", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d982aaa-b5e4-47b6-9bb8-bf0cccf08e56", "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": "5bd16396-eccf-4f65-82ac-0a1138037562", "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": "8409bc88-ef0d-456e-b83c-ec67eb46821a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c94f6547-07b1-4611-979d-13e9c1dc5456", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eea9d0-dfbd-4a52-b016-c747a1ec6b45", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2128bce-4092-486c-b98e-13838c30a76f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0377cc7d-edea-4e83-90f6-2ddb5f3745d9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f73efb-3347-4643-acfa-3179cabfe895", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eeed5bc-0f65-47ae-abb0-a909f07ba635", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4353c2f5-cdcf-4716-8af4-857c0ec45681", "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": "b30d65bc-bd60-4762-a21b-382cc469194a", "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": "734afdcb-af93-4f91-a42f-af48c49487fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88525281-3ccb-4084-b903-01a8508225c3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb370f3c-f9ff-45fb-bba0-69ba6ec6f69a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "489b2c01-960d-4846-9c25-b1112f5c7e5b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f513c518-e87d-4066-aac7-6b230457d45b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c88f5068-d9c2-46dd-98c5-7e8169a9efbc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82aaf09b-47dd-42a0-acc9-baeca2a1bdcb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eaab5ff9-3f03-49b8-ad4d-fb08ad40b70d", "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": [], "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": "9d73da88-a880-48de-a503-0871cf576251", "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": "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": "20e8bbbc-fe31-4aaa-a03c-256703ffaa5c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b6feda-8ae8-4192-bde2-a0a7dbd52add", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf929d3b-ceb7-426f-b460-d8d563b905ad", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943b30a5-2d0b-4424-85db-8f0e1fa3ce20", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43b41842-7235-46a7-91ef-55bab1ecc6e3", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aacd7b4-51c9-4d5b-aa03-31d7d5e8c94a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fab7b40-d625-4368-97a4-414ae48be0b3", "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": "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\": 1508,\n \"message\": \"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": "e830b278-18f3-4135-9fd7-6ddfd2bfd198", "name": "Company", "description": { "content": "Company endpoints.", "type": "text/plain" }, "item": [ { "id": "1b97a24b-472d-4959-a631-df0b4bad67a2", "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) `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=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nFor wildcard name search (prefix only, case-insensitive):\n- `filter=name%3D%3DAcme%2A` (starts with \"Acme\")\n\nFor company_id comparison:\n- `filter=company_id%3E5` (company_id > 5)\n- `filter=company_id%3E%3D10` (company_id >= 10)\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": "1a7ecaf8-6026-4d55-b0c7-9cdd06474d99", "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": "4df7b996-a7ac-4ee5-a2d9-9627cf9b7cda", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a45185c4-0b75-4e8c-b67d-54dfe938a13a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d69a81-e562-4593-ab4f-ba913e785fb2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe5c419-1ebd-4f2a-b8bf-303215de2dc1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ce2fc2c-58e6-4846-b04c-a63d0f115b87", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d91fc3dc-b439-4027-9968-145801b6d3d6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6febb19a-ee2e-4c62-8521-de6703950d85", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ffaaa62-eacc-47d5-838e-92c15a78423d", "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": "5ae64ffd-d189-4b2e-82e9-0d3910ff62e1", "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": "401170e7-26a7-4462-975d-9a07f762493b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e398de3a-aa90-42a5-8101-8f6538885f4c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f353bf44-7244-4910-8a41-897ce4c3ec64", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c29173-4bb6-4114-94d2-d0e5d1bda03e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c6295a-14f7-49ef-864a-675d1e395759", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c049a87-6798-4406-8efe-6c74087c23c0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671713e7-480c-4a72-8c51-63a6d5287574", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a09fcdd5-370e-4722-ad80-16783a986a16", "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": "ae9911cd-0acd-4568-8fef-29b76c5c5ce8", "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": "5e59255b-a31d-4d09-bfdf-9dbd2867c204", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9519f5ff-e570-4b03-b1b4-c5e39b821e47", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33714d5a-1259-4d29-b1f5-312879a76301", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289de50a-eea2-4999-b94a-3e8f2b0d1bb0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392fc824-d8a2-4492-9028-1bfd05d7b651", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74fdb591-4edf-4520-8487-a77c7de7fb46", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c1eaa7e-6e75-42a8-9af2-c5cbd2142e0c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89f3c3ca-6443-4945-b619-28ed574d92aa", "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": "0153e7d6-45a2-4f3d-896e-1d8de880d9f8", "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": "868b5719-0965-42df-bddb-c8ebaf1df92d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c20acdd-e4e7-41f2-aa9a-7ff72329b33d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d6b892c-0fbf-400b-982f-c0e813b98abb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08102bd-c80e-466c-81b7-c0f37668f246", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58e1950f-4192-4e42-87c0-5633d2813c29", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68210279-1127-4cee-9e0a-21b39e75ee6c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7a3bd0-24f4-41e5-8f94-c89c2d7c16d4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "116054b3-026f-41ff-8919-fe4b2c6f71b9", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "b739d9ed-a2ef-4a12-a734-d9a028b5bd81", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0da06a92-7b03-43e1-9ec3-3e9c428273a1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21446993-1532-4e88-943f-8d69093eb658", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a112f40-5e0a-4896-8508-e144a5c64095", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d23ad7c-6556-4ce8-a5c6-fab52cf21c8e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e82420cd-ff4d-4925-ab7a-25a63fc791bc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95211993-47f5-40c6-8788-37efda71ebd0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aae54a9-4c8e-42e4-89a5-01943ad8bfa8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d2ad41b-c532-4846-9bb5-15dc56c81eef", "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": "0943f3a3-80d4-4b2b-bfc2-34f6ef9befed", "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": "e0194fb8-d7ea-4308-980d-632d70cfa761", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60dea93-a032-46dc-bb4a-e0cc9d92c322", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b5d72e-b2d8-4e6b-8ad0-864d3c13b55a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e2d4334-191f-4060-9711-e5e27e2cbd12", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee50376-3674-4e8a-95d8-390bd22ce5b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "789063b9-5dc4-4e9a-8742-291f7aff2a97", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "076ff957-d7ee-449a-bd5e-15da9f4d7c95", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eeaf3d72-4e4f-4802-b88e-dddab30c2ec1", "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": "4059b6fb-56dc-479a-8c8c-10b29a715c26", "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": "a32b171d-b7fc-40ed-8c19-1425837eb1c6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ba9dae6-fe53-43ce-b004-ba3c29c8e84a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f2ac4b4-fa37-4e0d-bdae-f4ce605e743d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55faeff3-27a8-4fba-ae19-a724cfa1c0a4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89cbd36-d847-4dc9-8f01-a29065c183b9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded5937a-6f5f-4626-8bdd-5527c1806657", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "958a7060-04cd-4925-a2ba-9cbf6566055d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46e9db0e-11ae-4936-9087-b05fe066a9c7", "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": [], "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": "688fdffd-e9f5-4327-b1a8-c7a4bc08282c", "name": "OK", "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": "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": "0f0f9d9b-9f6f-42ae-baa2-a44079009546", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "365b7d5e-af04-4ee4-b63e-7da0e1e85d3e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c6688d-f1ea-4de2-9e73-935019e23c60", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d44b3426-7b70-4ecc-a835-37cd91af0e05", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f26eff25-2874-454a-9e78-9a17da881221", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7532e28-25b4-4af8-b158-f28d264f7890", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e41e0473-33f5-4496-9b65-4804d1f721ed", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7131e89b-93d8-4e87-89d2-2300df5b3706", "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": [], "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": "1ac3420f-58fc-4ee6-ac1a-f88eebbab579", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35039fa8-e73c-43f1-9c58-fcb5971387a1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c176f97-32d4-4731-a82b-065d3a0b7d61", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a39995dc-2ed1-47aa-bc3d-f3cded339be0", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fe9b3e9-ae5a-42f5-8900-5616de2e6e99", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f71a35e-ab6b-4ff0-83ce-e7159eb78381", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e96399ab-c036-4841-a19f-659857ade209", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5844a06d-da97-4bec-8279-38e12de75079", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "553dd2f0-5ff1-4c2c-8420-3821747b2585", "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": "7a871bbe-38b7-4ed6-997d-f6bb95d5eba6", "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": "64f31d16-d52b-4bd7-af25-ae3dc7d8040a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72fc4824-35ed-4a55-a7b2-4458f4b932d0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6762276-03f1-4a4e-bc5e-878565caf9e9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b4d409-3d38-4f94-9928-92fa10e263ab", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c8f588f-4ad9-4915-a83f-a00b92367a76", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15e2ae01-ea65-4ab3-8aef-4cfe8408880f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ceaec6b-62be-4f27-bce3-ba9b26a61065", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69eaba03-e001-47f3-bb44-f1f65256d432", "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": "6412706a-44c3-44ad-8fc7-0a867744b1f2", "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": "fcf0cc8b-f03c-4bbd-b205-dca1eca8cd4f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c883c8-3009-4c99-baa4-7181cdeb7b58", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd76e70-2271-4458-a34b-66ce51a2af7c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d26a4ab-7475-4d12-87b4-5a1ceec4cbc3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d49c2038-0bb2-4319-a0d1-5f7ac517225e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85862787-ac4d-47d0-89ca-1e6e5fea0f22", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c0d38e-eba7-4b44-8460-5356a2e6bca5", "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\": 1508,\n \"message\": \"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": "002f798a-46d6-403a-9edb-d7a1505fd881", "name": "Contact", "description": { "content": "Contact endpoints.", "type": "text/plain" }, "item": [ { "id": "dc71ac37-9d2c-4312-b87a-65ab43cc27ed", "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. 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) `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`)\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=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" }, { "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": "659b099c-de7e-4142-8c2c-75be608dd80c", "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": "a1f8c73c-c097-456d-b87c-174b9e28bc58", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff5b557f-8bd9-4b63-b923-34c5afc20e53", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef703735-b906-45fa-bde5-8a7f9be7ed85", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e77fd6e0-75c6-455a-bb78-1afb39483bfc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71827a9c-fbb9-4c73-b844-8eebddeaf5dc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d408130d-d414-40eb-be39-cc33744b3af3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd9647ef-c9f1-4bf7-b978-49b339339fd0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0de45c16-123d-4ad8-85ea-6d64916a6f9b", "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` or `phone_numbers` 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\": \"MANUAL\",\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\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a4bd9b5-34d1-492b-8b23-4cd0aacec540", "name": "OK", "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\": \"WEBFORM\",\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\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"INTERNAL_FORM\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0517ede7-545e-4f16-aaa0-92bc2d7aee4c", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e309d9b-ef91-405c-9fa1-c8f3eec24819", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "755075f0-8fe2-4d84-95ed-593e38ac877b", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e08ebe9-0ca7-4d5a-a15b-acaa01708e21", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "147e0097-a194-4a6d-9e1a-ab3be164d813", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1804a3e8-fda8-4e9c-9175-0a796465b1c6", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24bda97e-c461-4be3-8628-25f0d288cba1", "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0ccb87b-2ceb-4557-8168-93fc1f3a2cdf", "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": "04ea4737-05e1-441b-84c3-28a7e9fe47d1", "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": "8c92978c-8b50-4028-a35a-36f26e7cac06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0ab1cb-6e98-4f07-86b3-dd364bcdacb5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e52e06f-558c-4224-a572-36a19d7a17b7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ea3ad2-dde1-4920-90f4-a26510f29b88", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10d1413e-302a-4749-9906-cec656a15fe9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e1f67d-5c8c-4f5c-8a76-878dcf12b61e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dae2c7b2-8a7a-4824-b240-b8039b67e95d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57aa299e-b98a-47ab-9838-6ec511c09160", "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": "baf74b16-67d0-4666-848b-fd84e157d6eb", "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": "e02f8eab-2a4d-40bd-97a3-c87f8824b4a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a26ffe40-ac84-4727-9be0-e6eb54e5bdc1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efd3da2d-c936-46eb-a1a7-cdfe69fe2e9e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05d2da7-01c7-4f0d-a081-9b335d3b6c0d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d152d7c3-23c2-45b7-988b-7b02a32d4376", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d359ea-1520-4b4b-94c2-f94585fb71fe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f899b363-5e40-4542-aa0b-68de3283d8fd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d065aa2-2db8-4b7e-8ffb-9b9bd4ce057a", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "73336110-d096-4465-a1fb-acb2438cbbde", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1267116-1d54-4ad5-bf49-eec4da4c332e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7990dece-babf-450b-ad12-1db76a31d4cb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d999d4b-03a5-4e9f-b60a-6e69040ec528", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7669a22a-12b1-4eef-a899-b28af608807e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ec56e1c-1099-4704-b011-35a47171398b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50a291b8-2232-4750-87fc-25ab5bf4d334", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb84733f-cc58-41cf-81ba-336cb4e0d279", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be5aa20a-aa80-4cd7-8add-dd6fed05ccd3", "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": "17769915-bdeb-4ede-b0f6-6486ed7749f1", "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": "d881353e-5e4a-491c-a73d-a25420c2db35", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb59d9d-8886-40b7-b5fd-4cfae2a1bdca", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386ad717-1bf2-4331-ac34-0217f9699ca8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c63991c9-0a54-4c4c-862f-e01ec5cbef28", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1ce7911-8894-4894-b0fb-f54618ddadcc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97a9333c-b80c-4e03-8f55-417842cf3067", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa0e011e-d173-4492-aa93-811d381070a2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ac608e8-51c6-43ee-8fb9-a51d05f598df", "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": "29f5b38e-208c-4a32-aa90-35b6a9652e40", "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": "b5e3b192-48d6-4084-b3af-c6a5a742f5cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0cb2672-c715-4ac9-9f00-18ab9af6eef9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0218d86-3290-4333-82cc-df40160ca476", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3882b5e5-5d57-4f53-8590-9f56fad6d682", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ad07741-a093-42c0-8191-f4ad24939c57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25925802-3cba-4502-b5c6-dc83fdefa83a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77717adc-06c7-4c35-91ff-bf2ddd4f7821", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e40d8f8-b680-4784-9900-ee84560ed8af", "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": "d7147312-07a6-4faa-8919-d505298a87a7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"INTERNAL_FORM\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af53d09e-8c4f-4fec-b12a-6c311b9ca332", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25323d39-9882-4953-9284-2691977d891d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3d8e6a9-744d-49d2-9098-e3d934ddc889", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f13f498-f04d-48ee-88ee-40bbbfd16ee5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de8daa0d-67e9-478a-a4d5-37ac6991c9f5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e53fee6-3d41-44ac-b1bd-f64c5f6c406c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71730b29-38c7-4f47-8587-a98f150da64f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20e0878c-74b6-416e-ac1d-74c70d4ff18a", "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": "819f927c-a252-4827-8f06-53c253828d21", "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": "313c1124-191f-416f-ac60-729c6df9bfe1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda74ee2-8eff-4ef4-933f-994c761799b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab6bfe80-88e6-4ddd-ab67-6a85dbe879f6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fbec84-5099-4592-b4ba-22054d503718", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e17af84-9227-4dbd-9486-f60b5710e453", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d80bc49-c874-41f0-9caa-4fbe4b14fa4a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cadc3564-2f01-4a7d-989d-29f3ad342486", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cb0d058-929f-4569-ac4e-de4c50885859", "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": "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\": \"MANUAL\",\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\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ede9588b-a500-4d3f-99ab-c5a3c4f54f27", "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": "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\": \"WEBFORM\",\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\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"INTERNAL_FORM\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f290a1-ed88-4714-9619-a72df26c8514", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9ca4a1-0bec-41fe-aefc-69d9905ce91a", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41931b30-e0e1-4a84-9e44-28a4dc46e82a", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7566fb6-42fe-49ba-a751-3c58d49cb24a", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cbce1f2-0cba-4f06-bc48-3c0db2a8c68f", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a56853-a5b2-46f0-87ed-e2e28a87d986", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4470dab7-bd63-4b1e-8042-db1862f9a5bf", "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": "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\": \"WEBFORM\",\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\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d86e9fd4-0341-4806-9b6a-f8c249d93740", "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": "5eb2ea5b-b5ee-4e51-97ad-1ababf46714b", "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": "5135109d-9c05-4333-996d-fc5cb127bed8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c40959-34b8-4518-a066-22b6c0db8e61", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a216175c-fa76-4e1f-b3d1-7ce8213af7fe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca317300-0255-4afa-a023-83046106c2b5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cb6cc9-b182-4497-a3b5-88cf77967b0e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176cd0ec-20e0-4cfe-9c05-76df23c426db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6ddf602-5259-40a5-8e36-61fd58a58d51", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc56c3e6-9568-4af7-ad36-c79e5cbc06e6", "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": "49bd5bea-50df-45b5-9004-b5ec30d20439", "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": "8015c04a-86f9-45dd-9ac6-58c263aac080", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4ba8da9-e3c6-4531-975e-a27a21494cf6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84466341-c04a-4fd0-b292-301994ee12f7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3f665b-a295-4e06-8b45-9a533357b2bf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c43683e5-9b02-4624-8bd1-ab21284eca27", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbbf345e-a506-427b-a337-5020f41c06e9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3addb89f-45bf-418a-8286-e636b890fd7b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4917c84-4c62-4c52-a41c-87b1ffcd69c9", "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": "2075ed1b-46d0-4d62-a30e-1138a7b6dbaa", "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": "d7eb62c3-1ff9-45e8-9965-803280b35e8f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9658e71b-5057-4aec-af34-00a0e74108bf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a836503-e7a4-401e-838c-65eea110a723", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94b45864-e902-48e6-9cb7-6d360776fd79", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d671beb-6272-4cb7-a6b8-256d051d6f22", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4a23c1-21df-49d5-9f6e-395a06a1b91e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e70d0c3-b07c-4d3f-91e8-8d7a824a5b56", "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\": 1508,\n \"message\": \"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": "d23074d8-3261-48df-a687-95c0982f754d", "name": "Email", "description": { "content": "Email endpoints.", "type": "text/plain" }, "item": [ { "id": "ba512b99-5197-4e42-8472-bdaddb140975", "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": "e156a410-94bb-4ccd-94f6-55b889bc90e3", "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": "5821dc37-9fe8-4217-a8d9-82b774d0af10", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743e9264-207e-4476-8c75-6c978d5ee0ac", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ce7fed-dc4c-4a44-8e13-34fcf666fb7c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e45287e-975f-4b1d-a983-daf35fbdbde6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3789471c-c3b1-4c23-963a-aa5fd88eb29b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3f92bb0-8b66-456d-8c95-e2c5dfc58fcc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8531856-9f25-4266-b23f-4973fe52c6de", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "664f3e26-f551-440b-acf4-afa27fcc2550", "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": "18bb877d-3dc7-4f0a-8045-9d3723d89ea8", "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": "ae2e1f05-cc24-44ab-89e1-1dc53befcec1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a8b6d06-1cc0-4319-b4a4-0db595975f0b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95df9417-7c27-464a-821a-a33a2b3170e4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea304504-a568-4633-9386-dc2babdf6b69", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64c74ad-3423-48a3-afec-4e6f8d71481e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb6460d5-1931-4720-92b2-c5fa508350cd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e9e0126-fcfb-43ed-8edd-c0b9373908bc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eece02a4-2263-40a8-b21a-73a3310f7211", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "41b4150f-cd2a-4c99-a22a-a9d707100f07", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edcd15c0-c070-48f7-8e43-3d4849370c2a", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f0c59e-bea1-45f7-bf93-029f143a78f9", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4f58e23-4eb9-4f68-aebd-5e8958f8c14b", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a58bb0-bccb-4d96-83a7-fffd95a6eba1", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "119e8c46-8c79-4313-80bf-3c14750a1185", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "209b700c-2b6c-422f-ab0d-7731709d4a40", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "432c3e42-402c-4b01-af38-59ee6cbb61f7", "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 \"user_id\": \"string\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2f6ac97-3688-4a1b-a266-8df3c721da38", "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": "fee4ca2a-f051-4a19-9004-2e39022e30b6", "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": "c18f5151-2aa1-4e13-b5fd-1831fe18900b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43a51261-f33b-49cc-aef0-fed3f3e08827", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e5317a-196a-44ac-b4bc-6a7f0137ba34", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab7f7ec6-a177-4b5a-af47-5d93de0b57e5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a03ff359-2a85-463e-9dfa-a06e6e6dc56f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eecc864-c81e-47a5-8402-27abf40952bb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893704a3-afa0-48ff-9798-e6b6098821d4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f524d204-6451-417c-b4c2-842bb634f230", "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": "7a5393ae-301c-49ef-bcdb-9e7df160dde2", "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": "7549efd5-0b6c-4b7a-98f0-684968db34bd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17cec981-4fc5-4814-badf-b0e43ca22172", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff32cf9b-1f1f-4d2a-b6e2-fd7e45d8523c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f24ebe0-a65b-47d3-9622-9359de25c364", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38343bb4-b7e5-4cf8-bea7-e8d8fa4bedf6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c47e4707-12ad-40a4-b1cb-e18a68fe2882", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22e3ca2-ae6c-4eb3-b651-97da1d3769cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2942452b-8597-4ede-af51-ff808a4145f6", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f87f67d-1f3b-403e-840a-1b6282c51b57", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fcbeb88-3986-43c1-a48d-7df86d6f16f3", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628177b0-754a-4ca5-a01e-92fdcc87d16b", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a5b643-3610-4716-9b2c-986d315a954c", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25098255-81bf-4b9b-ba85-e1a581015fc6", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7401c007-f7f7-434e-9c0b-4931c925907b", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a06a7334-5a2c-45fd-a919-f34b0e1d5787", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcd821bf-6181-4a38-8481-a0351aa6383b", "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\": \"EMAIL1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2b37787-4e41-4ce0-9a7f-3d732c37c7d3", "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": "0429ceec-4105-486c-87a9-c614a203b62f", "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": "6e197869-d973-4683-8653-30bd440db8a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b9133a-e49b-4ba5-a414-a3315ab16426", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa895ffc-38dd-49ca-9d21-8cf3ce6e1f67", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "790656fd-025b-4205-a022-f1b01cb1f820", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35084ac9-8594-41b5-89f9-204ebe5f2389", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e900a93-48e2-4117-b6a6-dddf4f4f413f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "171c46a9-3f87-4360-bfb3-041e0ca02253", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c6a2a20-26b3-477f-86b7-b3ce61367cf2", "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": "96f356ba-01cb-4a59-8833-c2dd211c4367", "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": "b5c3d53c-49c6-41e7-9194-1bcb444c58cb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6343405-2021-435e-a885-cabf46bdad41", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f57c6997-b3e1-400d-9ede-87283c7cf890", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98b6c578-731b-4ddb-a864-b3ebf9d847b3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3561c1c0-39c2-40c6-b833-a61c684d8f34", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71543ea1-9033-4e10-bf95-75f8f2c9165c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46faf461-21c9-4760-8572-821d6d350e3c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7729475-391e-4ecf-98de-b3fbb9fa3848", "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": "2caf6846-a0c1-4f7c-a358-5f41aa1217a1", "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 \"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": "5598a073-a6d7-450d-bd89-1a9c9b3c3af7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "691658c0-5c86-4bff-a20f-b145f6b222d8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcd0b87a-729b-49f9-8fb9-7d279231771b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25964c51-2933-41c1-92b9-de38c96fc3ba", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b18edaf-a5f6-4e05-8069-038c26f88aff", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb42f937-d9ff-47a1-ba18-8b6105aa5586", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d118f49-df11-42dc-af2a-73b4c72ef125", "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\": 1508,\n \"message\": \"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": "59d6c0e7-68b1-46ff-9953-dbe3832b7791", "name": "Email Address", "description": { "content": "Email Address endpoints.", "type": "text/plain" }, "item": [ { "id": "564d1704-8dbe-4644-99a6-5e395c996d9c", "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": "d7235de7-8129-4827-b958-8ae6626d6b30", "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": "8812c2ab-454e-4e33-abd7-c4ee2838e3b7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa52102-335d-476a-a447-56a469403b17", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62876b14-7cb5-47ac-b8e7-1d9e4ea1e211", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b10654e9-1bd6-463a-92b9-e393debd3f11", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81da7d8a-dc93-4c5f-8ea6-d7626aa769ed", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a846e77-3ec2-4295-a6e5-63f343270756", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23c79052-ab2b-49fb-9bce-2f13d5bab39d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fa3e267-3867-4283-94cc-6cf823ce90c9", "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": "048fef12-d781-4422-8391-bc829e9c04ae", "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": "92504afb-adbc-4652-8b89-2bb12bd336d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e6d20c-40f4-43ab-8255-79a842bc6bdc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2d5540-9f52-40df-8963-a3176cf0b4c1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db3800f3-35e3-4186-a594-1e55a0ed02ee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e599013-06b1-463e-8eb6-20824442ae30", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2615928f-2e66-45e7-8b25-f72552f8c136", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7237a0da-5bc5-4c36-871f-333110218ab2", "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\": 1508,\n \"message\": \"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": "6dd09d1d-8fda-4c18-94e4-dee519b49b7f", "name": "Files", "description": { "content": "Files endpoints.", "type": "text/plain" }, "item": [ { "id": "bd4ddb7e-3068-4c27-bb8d-b19b0eab8784", "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`\n- (String) `contact_id`\n- (String) `user_id`\n- (FileBoxCategory) `category`\n- (FileBoxType) `file_box_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=contact_id%3D%3D123`\n- `filter=category%3D%3DATTACHMENTS`\n- `filter=file_box_type%3D%3DTICKET%3Bcategory%3D%3DATTACHMENTS`\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": "67e49964-4453-4134-8a78-67ab670722ea", "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": "70b49b6e-e407-4686-9ef2-43aff9c7e7bf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bd96bfd-94e6-4f30-93b0-67518ca52148", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05939947-2cf9-454b-9190-756a747a8b69", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a1042c7-8e93-440a-8da5-3e0ad4f3ce19", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5ef3f19-8e86-4ee2-b871-b1a6a4f10282", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1c0b59d-b773-4f73-9617-0e54c03a9709", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65de593e-0d32-415c-a934-5974ef35868e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e50f85c3-e819-42fa-99e4-14755d5229cb", "name": "Create a file", "request": { "name": "Create a file", "description": { "content": "Creates a file and uploads it", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "file", "value": "string", "description": "(Required) File to upload. This is a file sent as multi-part (not a string)" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "" }, { "description": { "content": "Contact ID", "type": "text/plain" }, "key": "contact_id", "value": "" }, { "description": { "content": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "value": "" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "" } ], "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": "is_public", "value": "string", "type": "text", "description": "(Required) Is public" }, { "key": "contact_id", "value": "string", "type": "text", "description": "Contact ID. Required if the `file_association` is CONTACT" } ] } }, "response": [ { "id": "89d26b3d-884e-4d40-877c-162d833e24ec", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "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": "e91f4595-6ae3-4d92-b226-bb107c536163", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833fe4ac-3247-41c1-a99a-6daeb2a23cea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2f8b5c-ac78-4c87-9a16-f0eec23d9a70", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce7ce0b-9a0b-4487-9308-9d4952dc43c1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "068e9b73-a2bf-4016-a764-25ab3d8ecfef", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "271ef9a4-c966-48c6-b5b3-5a9b49ec39e5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0af40107-d24d-410d-9263-078e1a077264", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "contact_id", "value": "" }, { "key": "is_public", "value": "" }, { "key": "file_association", "value": "" } ], "variable": [] }, "header": [ { "description": { "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": "(Required) Is public", "type": "text/plain" }, "key": "is_public", "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" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef833d4a-103b-4abb-ba6e-47feec4dc667", "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": "acbc2170-3b8e-41d5-89cf-214d68f7ce91", "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": "6277580f-bb2f-4409-a77a-b2a0750aa4e9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b07b4eab-5ae0-49ef-b1a0-dd920b76592b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3f362e-a51f-4eaf-bdc5-0caaf7c2949f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc4450e0-7a00-49d3-8919-062adfd90235", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4b39255-a36b-4bf6-817f-c5ed6f3e4c6c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ac0640-ce26-43af-8a10-c50c046f2d5c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6df863e3-e6ce-4be2-a375-7667780645b0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "254d2652-c21a-49b4-adff-97aaf0419463", "name": "Update a file", "request": { "name": "Update a file", "description": { "content": "Updates a file. Note that this endpoint is using a POST method instead of PATCH.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "file", "value": "string", "description": "File to upload. This is a file sent as multi-part (not a string)" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File to upload" }, { "key": "file_name", "value": "string", "type": "text", "description": "File name" }, { "key": "is_public", "value": "false", "type": "text", "description": "Is public" } ] } }, "response": [ { "id": "a76b1a42-ace6-4e5d-9e5e-5d649edab066", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"DOCUMENTS\",\n \"file_name\": \"document.pdf\",\n \"is_public\": false,\n \"contact_id\": \"string\",\n \"created_by_id\": \"string\",\n \"remote_file_key\": \"files/12345/document.pdf\",\n \"file_box_type\": \"APPLICATION\",\n \"file_size\": 1048576,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbd78af-aaef-4bf5-bd4b-417d0b77156d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a479a7-6396-4150-a60c-5669bdc1888e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6664641a-0353-411d-bff1-609f5a3ea794", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2dc89e-0408-4c63-b875-375cf3a5562f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2567d09e-b2c1-4d3a-be67-b578493760a6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b02cbd8-947b-416d-8e75-19bea4043f4c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b91291c-cc15-4033-9f92-57ca6fc27749", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "file", "value": "string" }, { "key": "file_name", "value": "" }, { "key": "is_public", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f023637-aaa8-40cd-afd7-bf3df90ac89b", "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": "86666b70-de59-4ad6-8b57-89137f97e355", "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": "ba0186e9-7bbc-414c-84fc-ab282604b1b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "355a33ba-d5fe-4040-ba26-7507670ddb9d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "582fc0e2-d208-446f-9a68-848dff5fe7f3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da5ea77-6d2a-4dd0-a508-baf6053e117c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e363701a-39e0-4a8d-b9fb-068d7113cca0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea45ff8-606e-4ea6-8dea-abe7a793e1c6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01628564-2efa-4cb4-9105-c32ba0d0517d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69921b37-7356-4b61-a39d-5d0bc50d6773", "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": "402fe443-3a88-418f-8ffe-5240ffb7da1e", "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": "7892658d-3df1-40b3-ba4a-7297fa0035c8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1690695-dde1-47b8-b50f-4c18a8e17c1b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "643efbe7-dde8-40d2-9c7f-395feccd96d4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e39a474c-e10f-4fcc-aa8f-c5e5e8a8ab61", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e015328-b820-4e8c-9abd-03c5f8606183", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "460d2f91-8d66-4c5c-9386-e32647c5f4f9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee0146dc-41fc-409d-8a31-6aa20bedd138", "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\": 1508,\n \"message\": \"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": "81c3d63c-33cb-4600-bdf6-381e6fc42b87", "name": "Free Trial Discounts", "description": { "content": "Free Trial Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "82a1d4cb-4ad9-487a-8a63-388991d00623", "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": "95fcd373-da9b-46c6-8fca-3210c5da7399", "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": "fb315de6-3f56-4924-9070-8ed99753f4fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57477fd6-e08b-4141-91c9-6fdefef20130", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd6c3f28-a428-4a55-bd62-751d5828b556", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4820149-f8bf-4b36-84fa-47d00c417c9b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f335ce0-a726-472e-b56c-34842396249d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08fa8e45-b5f9-47a6-8204-5818abd3542e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee1aa14-d933-4395-aa42-b7c188353034", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb0838c5-d7f3-41a7-83f6-b8c2495e3929", "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": "3f3042b7-39a9-4810-a1ff-431b73d46b29", "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": "097ce470-abe6-4e8d-8dd6-75ad6704ce06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07259a53-4dc0-4200-b185-55517e1d53e7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98b331b-0f8e-4888-bd31-5c7da9ef8dbe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3050237-f62e-466f-90d8-137b3abeee80", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "696a0449-fc24-44c5-bc36-6913d9a7d4dc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d842c714-6a1b-4665-a190-85695222398b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a09e0c81-a2a8-49bf-ae5c-378c48763b4a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06eceedb-0015-48af-ad08-ebbfd994a822", "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": "7d813688-6a63-4639-805e-8114bbd17f91", "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": "0ecb98ba-e521-4ae8-8651-35eb6c52c70c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f125f8-bf4d-466c-b3db-738d2e18a606", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001a81f8-3316-479d-b771-79b5549a1a7c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4da6527-1839-4e96-ae3c-a765b54869dd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236c929f-cdc3-4eaa-a0bd-d11cd8e27843", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26a6d732-7e50-487e-9ba8-9f3d67c4f2b8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f0e23a6-1182-4cc1-bdd4-f8f01406934e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bdd403f-96c4-4826-8afd-a7947ab4a76e", "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": "af056ae5-07af-43b5-a038-eb46ec801ce7", "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": "7b1b313f-da45-4843-95aa-8f9f5656c997", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40f31cfd-9a5f-43cf-9ec0-4aa27f162bcd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29473e87-f672-4dbb-9e9e-c979b34d28e8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf32e8ef-9005-45a3-be57-c8f515f681d0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb14a10b-aea5-433b-ac69-fab32ba991e8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c35d0e4a-d9e5-4769-b56e-a4f5c480adc4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d226e717-1ced-4211-844e-0586fc7eda43", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c352fd0-f89e-492a-9167-752486bab020", "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": [], "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": "05fc0fca-4a2e-4070-a340-d79a15111bf4", "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": "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": "d81573a8-1f2d-46a0-a283-16245cfc273e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a69d31a-9eca-4e97-b3df-660cc5dc3579", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06256e58-4f64-4cf1-8439-d1ee83f828c8", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aa1d20f-684e-4c85-b955-8a2693e06b92", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49f51ca8-f3cf-4d33-9e34-8038e73f9fa7", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d8641f7-9c46-4191-a8ab-c4f6cea0bd41", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e708e154-a5ec-441d-b640-c5ffcab578c7", "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": "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\": 1508,\n \"message\": \"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": "1bc72662-d06e-4b16-9513-161d835c21b9", "name": "Integrations", "description": { "content": "Integrations endpoints.", "type": "text/plain" }, "item": [ { "id": "180b8bb5-827b-4a22-bb22-e0dc8a4dfa7a", "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": "3ca62e9a-3a26-4882-adc0-bbd4c4c9ec70", "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": "9e9600df-a75c-4ff8-9001-9d6fe9b6d8db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4052826-0d5b-485f-a714-bd19a2f8eb96", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6887a10f-dffa-4c68-9ceb-d003b1fb859f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae44e09f-9731-438b-a1bd-736a61f2687c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7344520-c948-400c-a2da-0671034c4920", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df04fcf-4cf1-46d9-a4c2-b6845af46c64", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222e002c-3556-43f8-853c-bc2da4759d04", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "008fc352-3a11-4826-9e61-22e71176bfb2", "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": "63999fa2-82d4-4933-8799-88cb26c434aa", "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": "9546fbbb-c5ab-4447-853c-c068a4227508", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "619c1e3e-77f6-4999-b6f0-3e80085dc35b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76dfde99-96bf-491c-941b-f688ef2bc03e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69807526-c276-4b0a-a47d-205230270683", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11a53f1c-b552-4821-a0e0-79762f55d7db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29efce17-9805-4d51-822f-23da84d6a6db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16615d16-bfcb-4fd5-ac05-e4fba4f3af85", "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\": 1508,\n \"message\": \"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": "9e2ad30b-f35a-4d38-b73b-76bee8e7a350", "name": "Lead Source Categories", "description": { "content": "Lead Source Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "fe801065-9419-4eb7-a94f-98befaa8a926", "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`\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 is an example:\n\n- `filter=name%3D%3Dexample`" }, { "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": "acf3b929-9ac3-4fea-8fe5-b0a5a5618dea", "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": "90124894-0b53-4f9d-a203-8022dd52eb37", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb5468b-101d-48de-b537-81dde9a7d8bb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "381ebca3-f3ee-4336-89ee-5a7ca4b13c85", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c1f2a7-a0bc-4244-8135-04095c12a095", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6332d434-edb8-49fd-b32c-32f9a8d963af", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "795eb498-14f2-4916-b441-d9b893961591", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "002e2d13-8bf5-4e14-a803-3cbd59d48e9e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58da0e87-862b-4764-883e-21800c85a0cd", "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": "fd3a040e-d21b-4cf8-ba55-914d9ed91f12", "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": "d0f28195-e7c4-4600-9afc-1e1ccf784034", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1af297d-2537-46ce-8c42-c924e737770b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd68216e-5d86-4bab-93da-7e6882ff7b00", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f65cd8-e4cc-4f0b-a996-b10f69804e65", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424e1f5b-8231-469b-b33f-cd077f531529", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec7dc5ff-75df-4805-a915-3acf6426cd49", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c716258d-f390-4fa4-a567-9c8795924e6e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b4fc1cc-d19f-4faa-899f-e54df8325d13", "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": "0ac27265-45e3-4103-bac0-e1ca1be6e87f", "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": "409dcb1f-d51d-4039-b13d-513f8a830190", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aba62017-2a37-4303-8caf-cdb089531d72", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671bf750-2227-45d5-a8be-ac21af3ff111", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e82cc01-ed17-4643-b3a3-7b7ef4e157cc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6379e557-74c7-4106-a0ce-e91194d52ebd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e3cbc1-5df4-48d2-a361-57fc3191dbdf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e975a7-5932-4e5b-9495-ec654aefe795", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e52c367b-a00e-4cf0-9f2b-d49a09ce2a66", "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": "22b0908e-20fc-475e-82ac-1e8def1978a9", "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": "aea4bc06-6ac5-4f97-97d6-1c1a787e241d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7dc6374-6ada-4482-8ed9-1922db3c3c1c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ab917f-fcc1-4009-bd13-8913fd8cbac6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea3d7e7-6500-4966-85eb-c1f8db007c6a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dbc5726-fdbf-4eda-89d0-a20136b993d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e376b47f-7cec-4802-869c-0fd6d09080da", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12882958-2971-469d-bccf-db03a28a323e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2e82085-2a3d-4f45-89bf-f6e8b9bd9be0", "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": [], "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": "2053cb24-33c2-4bb7-a80f-9ec7bd8a3dd3", "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": "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": "5a8be489-bc59-46ef-bf57-24d306d45147", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eca5fea-0f79-44a3-b2df-d0db34f05640", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef4d13b0-18b9-42e2-8473-e935fb759e2a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb7fb3a-cab9-4e11-abe3-64b84692a646", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed9e3f13-d75a-476d-bc28-056b4e2b1d49", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ed2e18f-a160-4dc8-a8f0-f35f81b5934d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775ba985-3c9f-4567-994d-aa8962c388de", "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": "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\": 1508,\n \"message\": \"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": "826e8244-b695-4a46-93d0-328309ab8078", "name": "Lead Source Expenses", "description": { "content": "Lead Source Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "5e2e4440-7857-4483-b674-46337bba1500", "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": "005db0b9-8896-478a-b2d6-37fd9551b8e0", "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": "fb06bbd4-7809-47cb-804d-a4b470698fef", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ab37121-f50d-4b38-b157-375db1be45c3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e7531a8-9bb5-4f4b-9e68-cf0c73411e0e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4af096a-a7f5-44aa-97c8-2c560a913b0b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18ca93cf-ae24-46d3-8b95-924a674fae9b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1193fb7-21a6-4ff2-bb16-688b7728861d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dc945e8-cb3c-4c49-b225-171878d10301", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a973ae47-8aa6-4a9d-be11-9bd6da280304", "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": "0a3fce3c-e4d5-4327-addd-b6c1a125e6a2", "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": "394e0c37-8dc0-4a0d-9d4e-753abd49078a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca593873-ce49-4765-851c-bdf3a15e095e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751ccf8d-dee3-4713-8d68-b5e3282f0b76", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a52a800-d5e3-4032-b6c8-17e6d2593ed8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb28728-4bb8-4f99-9ba7-3a28d6f60721", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73737cba-7b95-4dfb-abb4-638b5adb0197", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cb7c12b-4a29-4354-a6e3-4403a04fedad", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a102679-6118-4315-b461-1b7c7b4099af", "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": "4fcde747-a53d-4307-87b8-48999ee44a1c", "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": "8620f1dd-d6f3-4e1e-9a52-2fa63f7b3de1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a2412d-538f-47a2-87ac-0fce55078ebc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99004e2e-d93a-4136-81ed-31a9ab258b78", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9565673-8324-45d8-8f47-6fc85a16deac", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45bd8246-a564-4fb6-b883-c2bee3873d59", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef00edbc-be82-47d3-8f18-3c6299d878d0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e290f9f1-453d-484a-85d0-e103e71c2efd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e58949d4-56d6-4045-9708-31b4a874c51b", "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": "70a8553c-419c-4447-822a-83f4b11d7759", "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": "018f47c7-948e-49e4-92a1-b8b4f75ed623", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "965fea43-e0a5-4e3b-89d1-335c3276490b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b518bc9-3f05-450e-b65e-7342c6fe8f0f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d642d66-05c5-45ce-aca1-3f599f7fe55e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab2a1270-1413-4bbd-952f-d6abc421865e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "085285d9-02ac-4b96-86fe-9cf8e4a6e516", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca65db45-e813-475d-88fe-20dea8f1db84", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6b8d0a8-ffec-4da3-9d79-acce600a157d", "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": [], "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": "0a12a252-c512-455c-b159-0ede8cec61f9", "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": "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": "27e9d3ef-8c3c-4abd-89af-f35561182733", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c908b137-b641-49da-9700-63393b5fe3aa", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf7d374-7241-423a-88c7-ddbe69e6d209", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d3fbf7-8064-4eda-9c8a-62a11e53aec7", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03f951ea-4b42-41b8-8729-e01433979b16", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae7af081-79f2-40ee-bf0e-762a1f7a8559", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88af9908-9a0e-47fa-8875-e62eea785096", "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": "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\": 1508,\n \"message\": \"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": "62f4e0f9-215d-49fb-b357-a0118fac5dcd", "name": "Lead Source Recurring Expenses", "description": { "content": "Lead Source Recurring Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "824f1c7c-ff50-4658-9316-7a7835a3d335", "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": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2a082c26-e13d-480f-9f21-55706687e7c9", "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": "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": "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": "47a5999e-f3f0-4845-b331-f4e67a118c2c", "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": "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": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d955a113-d0a0-4727-a870-f968e144b6b5", "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": "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": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df1e8ab3-40da-45d9-b655-0cb952876d72", "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": "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": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a4352f-5c7a-404b-b605-a697e5d86858", "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": "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": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3d0dcd9-2e42-4e16-90c4-0518ec8a542f", "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": "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": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "300ab6bd-31e6-4311-bbb0-1c3818942a5d", "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": "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": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4e10818-284d-42f8-91a5-33d7b5867b1c", "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": "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": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "246bf6cf-d647-44ff-89cd-5417e3e15a0b", "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": "34d298b0-94ed-439b-8d81-082df192828f", "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": "e66251d5-6192-45a4-b0c7-f8185be04902", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1cadf86-6747-4b7d-9916-372785cf0e98", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c0b2c54-fe62-4f4d-9ebe-113bfa72f80d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8ffcac-c406-480f-97b5-a86f79e70311", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f443d1a-56aa-4bb2-8b22-e3761c66904e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e869fd4e-2d62-4139-b319-f3c20abb50ea", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94409181-fd95-46e0-bfc9-227e728fe436", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "604f9b83-0144-4442-9065-e81a184f8f80", "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": "4697caa4-ae68-4c10-8d77-02aed7fc970a", "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": "6f0dec15-3e11-4334-8341-211dba010f06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c7e0fa8-5a47-496c-b4c2-3672e21e407f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04bf0ace-7245-4fae-bc59-95f64ddefb34", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33991c96-f599-49ff-91fd-f0c8eb443293", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f8a1750-9c9b-47cf-a5a9-77bf1942d52c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b52d3c60-8a54-480f-9d48-10afb91c26a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5524f93f-b450-4615-989d-4b1cfa51c35b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce3ab8b3-90e4-4f0c-b763-604f97634065", "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": "28cb860f-1135-4b63-9cdd-21eb31ea8ad9", "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": "d5dd53d3-863d-4d8a-b093-fe8339ca6556", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1fae3f5-78ef-490a-b1af-c00bcee4a106", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f79a19e-792d-492c-ba44-8d739c9a1fc9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2291edc5-21fb-49b5-b134-1d86076d3a00", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f753f18-0b61-4833-b2ce-6729e5933e00", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ace377e6-1518-4c85-ae9f-8d5254b444da", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b8ffdf8-3453-4687-9fc1-fe594ec658b1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f7a9e89-e086-42b0-b640-4a56acd6d95c", "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": [], "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": "6eedf0f3-0791-41fe-88ad-84ce31ff34ad", "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": "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": "918abc27-8946-429c-8b4e-6a6cdd8fff37", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e07b1b0-6775-4d19-a8d5-8fd0eb77f5ac", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20d546b2-d750-46fc-ac14-8edfe3986f17", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df40c48-8b4a-4229-9a64-924ec17e52e2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbdd715-11b7-4aef-bddd-bf553a9a2233", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f81610-c03a-406c-9287-a9d011605439", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e08b65-6ce9-439c-8134-651f94e71971", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91e1f904-55f2-4dbf-9017-f6b8c259c715", "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": "faac6e61-3657-403c-899b-b4e24aca979d", "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": "abb0e463-b627-4490-a796-6fbe201cb0eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a0fce4-95f7-4a55-b8b8-0300fa2eace6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1fb9e6f-e332-4eb5-acb2-e9b17a61a462", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ec4510-8dbb-4d33-9888-c7f91d157a42", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a561ad-b890-4482-96ff-35a201de8266", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc6f0fef-2736-47e9-bbfb-6b2eafcc06e8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d844cd5-47b7-464b-9bfc-56cbff3773c3", "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\": 1508,\n \"message\": \"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": "113bade2-c134-400b-b8c0-a837d1326357", "name": "Lead Sources", "description": { "content": "Lead Sources endpoints.", "type": "text/plain" }, "item": [ { "id": "b0888ee3-ea34-48fb-be62-237257d52414", "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) `name`\n- (String) `status`\n- (String) `lead_source_category_id`\n- (String) `vendor`\n- (String) `medium`\n- (String) `start_time`\n- (String) `end_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=name%3D%3Dexample`\n- `filter=start_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- `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": "12de89ac-9f00-430a-a683-64e2a7bd7c23", "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": "616437a2-bff1-4e8c-b920-cc5748134952", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd36684-09bf-49f5-b612-0e815eb475e5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9175ce82-f6be-4eab-988a-53abadece483", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c31884e-c035-474f-93d2-51bf06ad4db5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e28e206-8e61-41cd-ad05-773cdcb6bd6d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99bdf647-07bd-43e3-b331-7388b7688865", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04b7bea6-c7c2-4114-b7c1-9cdb13b2ab83", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "982f0c8b-51ec-4681-a866-46c39de74a47", "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": "1ad86876-174b-43e6-82ec-dbf7c57b77c9", "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": "339cdc8a-ab1d-4943-85c4-698a46331d06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88455302-8e27-4129-b849-88af6ffc7206", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c4d078-2c67-46da-beec-f231e37f1600", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2544e05f-5239-43e0-bee2-1631563e3c4a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac67c60-0483-4fdc-9a21-5a8d399f8699", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e1142bc-fd14-484a-a17d-4431ab673861", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23e646f4-b29e-4e40-a201-2909e2d5e01e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c94dea0-b305-4e86-8abc-8158ba413c01", "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": "7b58b51b-2b48-419d-970f-ddcbee5545a5", "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": "2b51c29c-8df3-42a0-8133-aa968a734e1c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94fec150-1fe4-4284-a680-59ae85939a86", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc1b00bc-4425-4f18-a7b7-43b250809c35", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7ae34ef-6e24-4c42-a1e9-a9da46978909", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4d03c69-aebb-4d88-a546-a6c524da04fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "204bf350-8486-4ab0-87c5-12f18b73a5b5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e91934-b7ab-4213-b73e-d25b77c69f6f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fcf6068-4d6a-4bae-bcae-88a7924b6fa3", "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": "7a3e9798-3302-4a5a-a090-a531ec289c58", "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": "eca3aac2-02cf-4f16-8ca8-1d119b8915c0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d0a0ad9-1faa-4d47-bef7-c21160ce58e5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "229286cd-2c8a-4ed2-a7f2-6f1147602a87", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4504b557-7035-44ea-a111-280b62bdbd6b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "839dbeb6-26f3-486a-ae7c-c7e17135c993", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "363c21ce-6fe4-4590-90ab-6f24e8859bf7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18ccda89-eaeb-47c6-bf0c-0dbdab6fd4ca", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bf1bf49-0f3f-4ba4-98e1-ab5fb4fa6cd2", "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": [], "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": "0b728854-f4cc-4872-b350-cac3d329b14e", "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": "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": "5070d520-726c-4df3-a3d7-d45973cd8db4", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc735bf0-08bd-4706-9c67-239f14335de1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86f5e11-77c4-4a34-bf09-2087611e98b5", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b1b4f5-ca66-4096-bc70-994d53c9de14", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4a390cd-be36-4ad3-b68e-6a903211732a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581ee5fd-563d-4c20-aa8f-d5461b24a784", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae8c357b-b9be-4513-ae13-dd16934441e4", "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": "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\": 1508,\n \"message\": \"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": "10883338-c514-43dc-9aa6-9eaf73599675", "name": "LeadScore", "description": { "content": "LeadScore endpoints.", "type": "text/plain" }, "item": [ { "id": "8e4f5741-421a-4646-82dc-ef20b09f03e4", "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": "b102d5f3-4a19-4f5a-9a0d-b4c7794a1203", "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": "eee48b35-e458-448e-927c-ac0534239b4a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53a0e48-1d07-46d1-b812-15c59ce3cacf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5ae0009-8721-4b35-84eb-3262f5338866", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05537d9f-6b91-4234-9db9-9fd1c1b8e624", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4b51c7-60fb-46d2-97bf-fe193ebea17d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82798060-fe68-4b23-a4c5-ea3018b8e5bd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b27580-e82c-48b6-95e7-c5bb19eabec4", "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\": 1508,\n \"message\": \"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": "ee63a7e0-ad1b-4c1a-81c4-04c41c9b4b2f", "name": "Locale", "description": { "content": "Locale endpoints.", "type": "text/plain" }, "item": [ { "id": "6ea34d68-769c-4649-84aa-39a6986fd2c4", "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": "e9bdbf8d-51a2-4359-9688-575652a83468", "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": "227948bc-d697-4380-ba05-bbd29eafa8d2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f2f62c-50bf-4977-a960-e1d8a3c1ee04", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af1f4208-f7b2-4e1a-8647-e7073e8d85f9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "363c7903-40f9-44eb-9dd4-7f1973de5918", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea4ca35-400f-4cf7-8834-240445040df9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd483f8f-dd1b-4b05-84c0-4ae7a95364cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2876b9c8-e419-4f8d-b242-7839b2c82101", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "567e7d04-f01e-4d51-8f34-b24c2d585e93", "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": "9b40b2fe-9562-475d-b055-df3771e10594", "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": "90d66687-1ce0-4836-be2f-04f06d6773d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90a98b4d-6296-4672-8573-d616f9688d81", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24969f03-3ff5-423d-aafb-9fbcbe6cdf80", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f30419f-b12b-4fbb-9cd7-29575cba3912", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f74d14be-8f9b-4c48-9022-25b5bf248e5d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd55af27-16cb-4ef1-a577-fe457185e51e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26df6a68-453f-456f-bfff-88f7163d1077", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02c4244e-8b23-4079-bd53-877e9000d913", "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": "e0e84646-4a0b-4209-a83e-43c90fbc0291", "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": "4ca10ead-95a2-49ad-86ae-e3a69a462c7f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fefbb47-5d7a-4a1a-a342-1df57410a7a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44a8a52d-9018-41d8-bb0c-cde81c01787f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7dd621c-d45e-4064-a5de-9bc871188df8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1424b85f-21d4-4b2c-91eb-2ecdbdf1ce99", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0fde66-adfb-4613-a190-d5814930a513", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99777712-770b-415a-a6a9-20242a7e1c1a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73b80e4f-a8be-41f8-b44c-dd8748093e51", "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": "cdb3bb5b-b31f-481d-bce2-de35ac2f74af", "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": "27a37092-2605-4221-9f85-2eff9c9c634d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66aa9c32-6ce3-45ec-88b9-5b62ba83d4e2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19561472-48c8-4e41-9775-16ef7a3cceb3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "598e1e95-77a6-4d26-917b-077e076a2e9d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd5829f1-01b0-4c59-af2d-26e0df62409c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c826fd6-68ad-490d-95a1-ac4d5ea62365", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7797e0db-1a44-48fb-9687-1cf064eff930", "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\": 1508,\n \"message\": \"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": "62c2d9f4-f335-44ca-8b71-72a0f426de9d", "name": "Merchants", "description": { "content": "Merchants endpoints.", "type": "text/plain" }, "item": [ { "id": "f93f753f-0b64-4124-ac0b-f6f63516bb61", "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": "be0915aa-c350-436d-9a0d-d1789bdf621c", "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": "7aff33bb-3891-4054-a7d0-1a6689153430", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8d378d9-d614-41e3-80ef-dbf0d19e5f9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d8da7f6-2e29-4c14-887d-1baa7478ad8c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "431918f9-972b-4c1c-bbf0-1a018eb55ad3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "114c32e3-9eb9-4919-8ed9-21501115b858", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f76bfe-ee8a-4c28-b91c-28beb7b1ca4e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfeb04ab-b32d-4fd6-9729-1b6058281a39", "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\": 1508,\n \"message\": \"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": "c3db7f9f-5e22-41c6-8bc0-94e4408dc554", "name": "Note", "description": { "content": "Note endpoints.", "type": "text/plain" }, "item": [ { "id": "b7e87c62-ba93-4b98-ab88-12302a0e8865", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "6cab30d9-e802-4ce2-aca1-2d257f9fe3fe", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6869272f-5b82-4d7e-b688-d6f484882780", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b4a2f8f-56cd-430e-b2e5-3912ac6cb6a7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a17a90b4-afdf-4140-9d11-a7829b6a2f60", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ffce205-2bdb-40af-8269-bb06bf8047ed", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e442256c-a304-4374-89a9-fd3d144e9ea2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b9cfc72-ae15-41e9-b3aa-0ae731356aa5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "335bd7f1-6501-4e0e-8f94-61ad7efb053b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa74cb89-95a2-46bd-8793-ebdf57dbbf81", "name": "List Notes", "request": { "name": "List Notes", "description": { "content": "Retrieves a list of Notes", "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 are:\n- (String) `assigned_to_user_id`\n- (String) `title`\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=assigned_to_user_id%3D%3DUserId`\n- `filter=title%3D%3DexpectedTitle`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`\n- `filter=until_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- `id`\n- `create_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": "edc8c678-6c82-4fb0-b970-1316b752b66a", "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": "cbea4463-631d-418c-a266-f2de34aa1a2d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b803933-b0ca-4324-a7a5-c550872c2346", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e31641-c538-4591-b790-ee84e469003b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b9705e-c2ef-45e8-8329-5e6c8646fd0b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58cb2bcd-d30a-4120-b314-593904e703ac", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e185b57e-84f3-4705-98c8-ee4bcbe1a45f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdcd7810-787e-4ac8-be17-23b1a69e3f81", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f992349-7087-4993-9a46-df134e36bfeb", "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": [], "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}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "081bf155-b7ba-443f-a76d-e8d2e2eaced0", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "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": "f3270d1f-7d23-489f-85b5-e07bc2ef4d77", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52fe4d9d-f07f-443e-8b5f-ec64b6195c40", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7ec7b0a-a31a-489c-a564-25bd4ee6119d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c56e965-7213-461d-bd5b-faac5aa05b7c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e552eb25-f9df-41c6-b440-06905a2c9f80", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87f19ae9-d64f-4ee3-9b9c-f13a505df1cf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab44f17-2a33-44af-a4ad-ce8f195c57ac", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "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": "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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b99bc4a9-0688-4b2c-b5a0-9106f01639cb", "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": [], "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": "6d83af20-9462-4f6e-b7d9-a13a575437a3", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e34ebb5b-338f-484c-b318-211437aa61b7", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97014567-db72-4e43-b621-3eb41dda6918", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e78bb9e-9fbb-429a-b32e-8eeb8545d964", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02deacfb-bb27-4257-bc01-3f7872df74c2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210d43a9-ca8c-41ca-8742-1f94db9cdd8e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7b38b27-9f43-4535-85ff-005720f7675f", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572adf91-f386-473e-9e4b-f85c521b8aac", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05db7524-5b0a-474d-90b3-ca4accd65026", "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": "2ef719ac-ef4e-43da-9a1b-2172422fcd11", "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": "16347a8e-0eda-461b-8563-d86c1ba23bb5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767ba9fb-db96-4a84-9db6-502d45ad3b09", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d233c5fd-f232-453f-95d0-06ceb7f30a0f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea019b28-77a3-4893-bae9-23ca277daf23", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42fa49bb-eae5-4077-be26-b9cf80fe0dc7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3965b080-b2ee-45db-939c-ee4385e8efe5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a0931a8-42c6-449a-a46d-0126b086b6bf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d67b9f13-f84f-48eb-acec-e4b07364a48f", "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": "7a09c5fb-76a6-4b39-8653-875a2a63aa0e", "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": "f3823e17-ffe3-45e1-8d72-5985c31019fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2a3401f-28ff-4dd2-be7a-2934be6e01bb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc5a3fc-bcf9-40b9-b3ec-7a4b51c754d2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a32cb401-71cb-4bde-a59f-3727353eef48", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ecfd8ee-d3dd-4d55-ad0f-d14f09619f2e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bd31ec5-1a09-4947-a634-9a0b5bb106e0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a80c385-a896-4d50-83b0-acb1f62d2715", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fba5b9e2-bd02-4e3c-8c39-a38800d13aa4", "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": [], "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05a9d25c-c471-43f9-913b-88577de66dab", "name": "OK", "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": "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 \"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": "5209d5ca-d0e8-4e7b-a6c9-3b0e2e2a6bb7", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8256887b-c081-488c-8788-de5ad61b980c", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab37adb9-16b6-4ccc-8668-d7b8426f20d8", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a8d09af-6960-4182-ae56-03e1e7f3341f", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16ebe0c6-cc1e-4d10-a7e6-6a60fc9b2180", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c40a91-b34c-4915-86e4-411fca13fd20", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44dc91dc-b791-45b0-97c0-9d1d6f46fb69", "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": "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 \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32d9f0ae-442b-48be-bc5c-2d4c5d20460a", "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": "386530aa-75ba-44ec-9bda-5113325f78c3", "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": "bc7a4cdc-b023-45d8-81c9-e46819e30dda", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "615a0061-97f4-4f68-8389-c954fcb34a99", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47b76164-922b-40fb-96e8-b7d3e5149e9c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe75242f-e596-496d-96cc-9567956b0a41", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01526fab-89a6-40e5-9049-ebd33a3bad9d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1271bb3a-2c8f-4e50-9b1e-476b1b5c3dcd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0fb3592-ce41-477f-a2f1-b50739b730b9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15f14f4c-8820-4fc6-856d-30c939167243", "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": "86f8182d-b37c-464e-9918-5005cfb89273", "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": "ac8d01cc-04e3-4971-bd6b-ba913faffc30", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f050103-8278-4007-8f34-928bab3b6c3d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21f4a739-6627-4e8d-afed-3b560913c82e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e2d1a2-e40e-4d0f-b1e6-afb1b90f889e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "161f7c35-61a0-48f6-b315-d487a4bcef18", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9294c72-b340-48d7-9131-8709b8eb23f5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "517db0f0-8011-4cfe-be7f-57b92a23e6ed", "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\": 1508,\n \"message\": \"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": "888aadee-92c3-4d0f-bdd5-67aa410fd777", "name": "Opportunity", "description": { "content": "Opportunity endpoints.", "type": "text/plain" }, "item": [ { "id": "09cfc0d0-5667-4f0e-9294-85d244de1228", "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\nNote: `opportunity_id` and `ids` cannot be used together in the same 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": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b0f5d48a-5591-41d0-95d7-bbf7109aba74", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "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": "bb82ee1c-d59b-41c0-b260-44d69cc8f147", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cb4618e-2ef3-49aa-bf15-eb78e090f56a", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6062f24a-715f-4dbb-ad76-cd02e6959353", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af65405b-9bb8-4a45-a52b-c03b1767bac1", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93542583-4355-4156-a6fe-c3d08d956c58", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ddda04-25f8-464f-bfb6-7513e1972bb5", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313e14c9-08a0-40e2-8e99-7b5ea948dfe6", "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": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9eb36313-4464-42bb-bd7d-6e5c7103595e", "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": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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": "5a0d28a3-8710-47ce-9246-d49d5d2103e3", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0202d82-35e4-45a9-a643-7ce2e0cddf18", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5878194-1dfd-4e29-b852-f464af8fb84a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d219690c-cecc-4f66-b89b-9e33d17536f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f2298f1-c1f1-40e7-87f7-5798eb1fbd3d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9804ce0c-7420-4259-bf2f-fafaa5bb9266", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb6c961a-a829-4f42-a498-f4e5e47e8ced", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7919001-add6-484a-86c4-5b20220bd722", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68813f27-ed9d-4af4-a4be-2ca9fcfa08b4", "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": "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 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": "d1fc5688-7848-4109-a2fe-2a59f4847183", "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": "6c5aa2c9-c069-4b16-8e56-eb782526946c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61a51a06-6340-4188-8b05-319723a0e7f8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48de66cc-9b0b-4a52-bbff-627b0a3577a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "519b4068-cb56-4aa8-a5fd-a241f2192191", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb5bfa73-0730-436b-8187-37fbe1709005", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af01829-e106-4133-9fa4-f66593d3baca", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357280a2-f60e-484f-b63f-642f26eb49d0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0132dbd1-c2c3-47cf-b23a-1342c03fe33c", "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": "6819f5a0-795a-4c86-96d0-bf594672ba98", "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": "8c97e6e8-1f38-4896-8076-d14fcd446d09", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf55b95-807d-45c0-8a63-c24a0a1d9cdc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2109d40d-a174-4152-931a-9bb4692f9fbb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3fdf9c8-83b4-44cf-b93d-f4216957840c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6b4e008-54e2-4e7d-8c94-67641d9c303c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7ab1555-57ac-4be4-8e65-046539b1d5c8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f6dc97-12c0-49b6-8508-27107a2fb658", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28d0744a-a6f6-4e09-aa92-1602922587ae", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "f2cfae60-730f-4c23-98f8-59f0f8371816", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b118e426-6107-43ac-9e2e-da67cd821e02", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26455146-4798-4f68-a862-87627f9c2c6c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0246e73-92ca-433c-88a1-0667669ec016", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50eb070-7216-4f14-9143-72ad97357470", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a9fe04f-709c-408f-80a3-24d267ef0e5c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54c96e2b-65d1-4ee4-acf8-bdd554b17828", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1bccdf-33d0-49ad-86b9-f9fa1c76ceca", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c1c15ca-cfd2-425b-8e8e-de4d760d002f", "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": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "59f3fa9d-27eb-40c7-a049-34dd453dedd2", "name": "OK", "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": "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "967eebf3-5b75-4c91-b64a-6f46d590b41d", "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": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7793f7b7-27bb-41e8-becf-3377f9f11e73", "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": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5724d98b-4b31-4699-85da-f28e79b39188", "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": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c094c40-4050-4156-942a-0ec344efc67e", "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": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b9f0d59-6a05-40dd-aec0-825988ddc301", "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": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f0ba21-b3af-4cd4-a18b-ade3946c23ec", "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": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9000910-f035-498f-968a-6c304dd1ab3d", "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": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d5302f2-75f5-4ea0-8a5a-81f7b196fad0", "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": "eee9849a-3347-443a-89bc-4f1e316f88e2", "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": "d6d723f8-4f33-4651-b219-92386df6de2a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77aac828-65e7-4d7b-8409-eabbb10e2beb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70b65bd7-9502-4fcf-8aff-65a4e1dc93d9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82bbb24a-8f7f-4964-b6be-00f5fafb2a52", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8754800-b54c-4b7e-a6f4-8bd5e5745efa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f0ad60-64e2-4299-824e-ff00e269f93c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba76d07a-a950-4f4e-b7f8-3b33f9806f49", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e7ea18f-087d-4245-9618-524a374b83e9", "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": [], "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": "ceac849d-828e-411e-868a-0dd4fefa405c", "name": "OK", "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": "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "815d0de1-663c-476b-a1aa-89340ffd723a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a10fead7-b679-44b3-9a79-32d3ef9fd64f", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e097e90c-8072-4ed4-9a8e-05b58a4f7a9b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c37edac-4cf2-4444-9f2f-f3fbc5fed2d5", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9d03086-244f-4395-90d9-7010fd9bc6b1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e14dbe-24ac-4413-b519-7a03ae684d38", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "811aa3fa-8a45-4bbd-b128-9f055791eeb7", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1bd28d4-ae15-4c52-889d-8b1dd19b9e86", "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": "4d4f195a-8b73-4add-91e9-7df9ad1744ba", "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": "7e1c1718-27aa-4bea-8522-4a1d539b8e76", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bae885a1-c678-4c13-8be3-e0265f42cea2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8a0e0bf-e9ea-4968-941c-4edd00f4dfce", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9507a678-9ff2-4adb-99ef-86aabe8c6280", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06e516cc-5e19-401f-9840-b1520d890ae6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b2b904-3566-4935-b294-b648152cf306", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9443b39-fb39-437e-80f6-47c9c8cea49f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a0c246d-23c7-48a8-992a-803381106abf", "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": "3182d776-cfa4-4635-9bd7-7d2abbb68239", "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": "e2d702e7-d708-472b-836c-a4efb1e2606b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd847af8-37ce-4428-a937-20b685cb821a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ea40c85-4d67-4414-9684-40a7c497a076", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2767f92c-5f65-406c-be67-35662692499a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b51f2c0f-1280-4dfe-8ed2-c2107399e780", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb38db76-1dcf-484e-955c-faec730f2e3d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e6aa95-f282-4f4f-b7a7-3a98b0036822", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57e9343a-8333-4ca2-9b99-07087e37f00a", "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": [], "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\": 6103,\n \"probability\": 2,\n \"target_number_days\": 7235,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b7cc759c-9ca0-4486-ae72-7b8a6e2bc5a9", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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": "ab4e0c7a-143e-420d-af67-0e2d80825b85", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f42f8eeb-5639-483e-ae60-a1d79a2292bc", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2cba36c-756e-4f1d-adc9-84874e6af421", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0beb3eb7-2fa8-4ba7-bab5-e91619842296", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa6294f7-fd56-4e94-9ce8-ea4efdb6f0b7", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4afa4c4-ece8-4c09-a24a-71d539de7086", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c78d6fdb-c16e-4d63-8281-e350f3c46a86", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 3581,\n \"probability\": 2,\n \"target_number_days\": 1676,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b43907c-6bac-4978-bf33-c589e817549e", "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": [], "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": "b581db0c-260a-49a6-a97f-7bd55f85178c", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e9d3eee-9502-4f39-8bec-a680de57e7d9", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c849d2-42de-4e42-b8ca-a0dfb561cae6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc414d04-fa4e-4e36-b4e7-09ff250707de", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ae54326-72a6-437e-994a-4eb4ff0737ae", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e48270e7-9014-4f59-8cdf-88d6e712a940", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbb59779-6715-4189-b4e1-7fb2d9e8ff8e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef9ea97-40b1-4a0a-b4c5-88ef22bcf851", "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": "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\": 1508,\n \"message\": \"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": "d52ff876-32ee-492b-80d5-692f1824dc4d", "name": "Order Total Discounts", "description": { "content": "Order Total Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "657a6d07-6c59-4c2e-82c5-a5e0c0edf45b", "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": "6422800b-b1f7-4c5d-a891-646270bcfabc", "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": "a4ac998f-8274-40e1-a3fc-8af3f4b79b52", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8784550-22cc-44e5-a12d-a74e56c800d8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be6743a-b39a-4956-9708-ca20ba738c28", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff5aeae2-f110-4d06-8c93-ad2e09a157e3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdf304f0-5f09-45ae-964f-1d65c35717f1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b58e41-74dd-4eef-9154-57e8ac755ce9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "294b08a9-b9b7-4156-9a5a-3dc186f59eb9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ce2a96c-b439-4dd6-80fc-8b60d25df4d1", "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": "7458101b-429e-493c-a7a6-1ca3fa7a9588", "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": "9af3770f-1a27-4591-aa41-e8539016db3b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79621199-6b7d-41da-8b01-4adc89e4401c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cdee5e7-613f-4674-95df-f757f2791d4b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053e6d2a-9389-4c43-bd2a-7e8dc493f605", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ddd9fd-6203-44cb-8d2a-f9d78e78611a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7faacc4e-d6d4-4035-86e5-6857b7ad57b4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa037954-ce1a-44ef-ad4f-dfe83a7eece1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "029cf4af-22d2-47d7-ae34-4e8f8dbf6867", "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": "5835917e-7480-4118-9903-8d2c4b679b7a", "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": "b1625a61-bfdf-4875-ae32-23099d504d71", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05bff78-6a5c-445c-8679-967ee9cac93d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7125c98c-5d79-4f7a-9c66-0c2be3f4e891", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e6227cf-ea0a-4fc7-a4d1-97a1e6fd8496", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b81763-5965-4b63-9a79-52dff9f01a1e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfab0729-a979-4cb2-904e-dfe39b76cede", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f912ed4-25bb-4c08-bf77-864de683dc01", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d7c1753-12b9-4150-b52d-bc30e4d4241e", "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": "87d85221-d0e1-4d64-b114-882cbce4d7bc", "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": "35e6dbe7-e5c4-4354-90c4-34f84c1e42dd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d568cda6-d9be-44db-9223-a94cf94f8dc3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fda263c1-faa8-4058-aa88-5774a73061fb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4434c94d-cb26-44a3-a40e-90d4c3a566af", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1567bd97-f0c5-4576-b21a-256c30702307", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ae10c6-1b24-4178-a35b-e007b1e6b2d2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d7a0721-ea1c-45ab-be5a-e64b95dae343", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84b4dfbd-e04c-4a80-adf4-b0e48893cfbe", "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": [], "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": "ea046514-042e-4a6a-aa6a-98dcd2d175d2", "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": "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": "86646dc0-c843-4284-8841-d6cb4b939009", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bfd6f8e-221a-4624-81be-92cdadb1aba5", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "110b2974-79c4-4bdc-bd5c-20d74021ddf4", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827f9416-3fa0-4858-8ea4-3cacb5e705b6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b82229-3bef-4ac1-b9ce-541b00f5d676", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b094d3-92f4-488d-8d5b-8579db1e93f3", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c661ff09-a531-4f17-90aa-6c76b1bad1b3", "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": "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\": 1508,\n \"message\": \"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": "effec0b1-4d96-4d62-81ae-389ec4c12b42", "name": "Orders", "description": { "content": "Orders endpoints.", "type": "text/plain" }, "item": [ { "id": "c03776d3-c578-47fd-89d2-b43c24c9c147", "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\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=title%3D%3DOrder`\n- `filter=order_type%3D%3DONLINE`\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\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": "5de5cf3e-d3af-43c5-8b5f-e20d21184c25", "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": "c6a24120-4a47-4f91-ad4d-ff30e704cf7c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df03f1f-29fd-42d8-b16a-391880af68a4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5057f643-65a1-498f-9341-a74e1669d8fd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a54411db-1b0c-4ce2-9448-974b5c5801c8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978e8cd1-d482-446f-9c95-6e8c93ea5c54", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54269912-846e-4e3b-a2b4-912fb727789c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1520d554-e9da-4da3-b1fe-c22906b2b97a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "363c3758-cd9e-4d9d-87c3-1aac07a78370", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cba7f713-3f90-4523-9f8c-6f1ca18a6cd0", "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 \"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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aec3792-3f60-488e-98c2-233b7eaf138e", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00bbe90b-94b3-4b8d-bdcb-1a7244aa65c0", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f647a08-603c-47d0-9030-3aab5db5be8e", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea18986-1de0-47b0-ac2d-5cdfde43331f", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5686e998-c4a3-489f-824e-e1f752eeee6f", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12cf3fd8-3b9d-408f-941d-9ec2fd6a3037", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4206675-d66c-4ebd-aac6-a936d93651c4", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7a29c1c-c527-4c63-846d-308e7cac24c5", "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": "699acdb9-2fdf-4a35-8548-e160d2ed09d3", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5dc6d8d-3d37-48ff-9f07-3d7489f9c401", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a451380-07e1-4ea9-b9f3-2e6e8698fec1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14a9d28e-a372-4f26-8c6a-59c12a70c97a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebc48129-563c-4a34-a938-81d45b9f4cb8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a4a32b-dbf9-45bf-bdd1-9f68e8ce1381", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8920edae-ecb6-4c19-ae10-9f399998989c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86ad34da-194f-476e-9028-f166e523f1d3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82fb4280-8d4d-41d7-99a0-df0af0ab0337", "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": "170577c0-ff36-4fe1-b4ff-60e2247c0bcc", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d811c3-9124-4e95-b2ee-f568ded5b15d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1463bdfb-7b1e-46dc-a529-dcfaac837fed", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d08f4e-336e-4755-a4bf-4d15cfd6d9a3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbbc0ff8-0232-4126-b3b0-040721c08bc2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0127f4-fbf1-4552-9bb3-fa3facc86115", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad341737-992a-4917-a769-9fb7bb8ebb9c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af013a7f-13c4-4a05-a3f3-fcd139a75a49", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab7d4ce6-5814-4b54-9997-69be76bce447", "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": "791f9272-8669-45be-9fd0-abd1367de433", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "182f2e00-7b9e-4f4b-836f-15de204f0d5b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12563a6d-186a-426e-9fbf-c904bde9767f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ffa6861-7cc1-4b62-a51c-67b976bd54af", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae5d7a2c-3dca-411a-88a4-302b90cea270", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ed0b21-dfae-4e29-9450-45a81ccdb18c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f8adbc9-5d31-42e5-802c-5b8b81b26c66", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85dd7902-d74b-4107-914c-32f6c1cf8e73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "114d2735-0608-4b3c-ba42-bef7bdd0a52c", "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": "4dfdc264-f67e-40cb-a057-cd3934ff4e09", "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": "a77bd956-4fea-4c29-ae63-a47b1919a15c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb2096e-076c-49f6-87e5-d4414a637263", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a3160c1-1fd8-47bc-a64c-514e68c5d7f3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc354a8-432d-410d-92f8-e915c09866d5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343f6898-c574-42c8-aa57-3b51ce2692ed", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6a8144d-7add-40ed-825d-140c1edfec06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e0b58c-18a1-4e39-8786-4a290cd27bf7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cb1f47f-45e9-4213-a7e4-f3f1614770ca", "name": "Create a Payment", "request": { "name": "Create a Payment", "description": { "content": "Creates a payment record. Alternatively, adds a record of historical or external payment of cash or credit card", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "61532f45-e5ea-4709-a1ec-e453c0a40eba", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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 \"invoice_id\": \"string\",\n \"payment_amount\": 99.99,\n \"payment_status_message\": \"APPROVED\",\n \"transaction_id\": \"TXN-789\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e91ca898-902f-4aa2-902f-ca9e4d5547c6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0a3b0ef-2684-4d2b-9ac6-e655504a20ce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acf4209-bd5a-441b-9ff9-0b83319ee64f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ad4fb90-f78c-40dd-b8b6-2d1e4313a443", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa32f7c8-2fd8-4580-94b3-ea07a86f9e89", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be150a09-aac0-453e-add4-7fba5ecf58a0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d122f6be-5137-48c4-8633-5a50aebe040d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 1166.1177503361664,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b72955d-4692-410d-8690-678faa427308", "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": "6788dc22-7472-4e48-aa35-c82d160c1b08", "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 \"active\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"allow_prorating\": {\n \"value\": \"\"\n },\n \"product_id\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"preauthorize_amount\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0635b0b1-9cfc-4da5-9aaf-735d91be5172", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f43274-cbd4-4c80-be40-ddd71144f3cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68f81c22-863d-4587-8dc7-37969334d9a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc37e8be-bd2f-4672-a676-a289e5c815f0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f49a4fc-f28e-42c9-9439-151ec2d8a683", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2339df38-4549-4c9e-996a-9fe6eb3102c7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c3329ed-d36e-4cde-9ad4-64a2b1954075", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4fb09bc-83b5-48a0-9426-414793eae6cd", "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": "b0dd82d2-b7f7-4cce-b691-0bf57ed9c954", "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 \"active\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"allow_prorating\": {\n \"value\": \"\"\n },\n \"product_id\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"preauthorize_amount\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e8cf1ab-3ff1-41f3-a991-da9e91c5dabd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc13b621-8339-4c4b-bf01-e0b479071b24", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8788a682-bf5c-41c8-905a-54c8e15e8917", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb0c797-7dd8-4b6a-aa23-ad19b834fb12", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ba741f-f336-45a8-b393-acc4130efa99", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e048b5-55e1-4aad-abf4-57e284c8014b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8912b14f-5b78-489f-b356-6ae964fff15b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15abe3ed-76e4-408f-ae89-c87df186b633", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "2d228358-ef93-48cc-aecc-3165d2f1c7ec", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada723bf-3501-4aac-ab31-ffebcd64087f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8975d32-7cc3-4d9c-b847-f836a9fb22d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f97c2714-3cbd-45ad-99d8-6d8a6120bc15", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ff45ea-d581-4b26-bdf3-a8ceb305fca3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "593bf7b1-6340-495b-8957-1c4112bd77c0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5c72a54-f2bf-42fe-8060-abb90acb4e13", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4d1a030-01bc-43ef-92e8-77192bd41dfe", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c554c98-9e2e-4c50-96f2-9c9f96e9d287", "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": "1a9eb18a-5acd-416b-8c90-7a5a2ea638f9", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56cff790-8fdd-48ab-a251-9bffad144e93", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "557b9fae-342d-4444-bc1a-b14dd515071a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a5c20e5-b791-4141-887a-312836bd15f9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e73b793-ca12-4883-bb5e-96d4eb334d32", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54f40ce0-c64f-4bc0-8db6-b545127ee4ff", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8738ffb8-cb05-44f0-9fdb-b3a1a964fa27", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb5658c-8a18-4fb5-bca5-28376c8296cd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0551465-3381-4eae-90f6-57ab6f0a92cd", "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": "09cf8667-3061-4f45-83c7-3741a9e77b4d", "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": "3aa96ea1-c32b-4874-bb49-d8db52505a29", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d909b7d4-65b6-41b1-a7f2-38e422e22c5e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa837dba-4c6c-4b72-a933-58d138ba52b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "542197ba-0480-4a6a-9a63-10e4b17fb01c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19324df9-88b4-4969-b156-eda461eaf483", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a857701-a5a6-4831-b687-15ea57f4a07e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0896e13f-4f18-4eec-8575-20606a8301be", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "691165ae-1de1-44a8-bbea-13abe0fbb551", "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": [], "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 \"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}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ad1c0b1-37bd-4615-8424-658ba9c655ec", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c909b05-bb52-4d42-b447-66e775b98173", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ba0b97-e20d-450d-97be-5d195372ad2c", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02c2d028-c4d3-4765-a493-a9175fadf5c1", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30dbc00d-1e02-41d8-af14-6db585dbe9db", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7636896d-710d-4a28-80a9-8121adef6238", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c6c95a9-83f4-4ed5-9032-0f48e21d72f1", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17e19a8a-e158-44e4-9048-36d11706815a", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\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}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "744d4271-1e52-4fa2-9406-a25a912663fe", "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": "aea63208-cf87-4023-bc13-773ab030a6a7", "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": "51693163-a9c2-4434-b363-3cb8afcc964d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7086d14d-9754-4067-ba22-0d157f106ff9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a11424d2-64dc-4d52-bf35-9ec917227709", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ea05f2-d218-4adf-af9f-144ee66249fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc968703-77c5-4638-806f-8b0c245ed557", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b126a2-350f-4d15-9759-5ceff2207a99", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a53060-9b5f-4fd7-8e32-5a27b7d0282a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9af2a7bb-c3b5-47de-901d-b1f7c0af9259", "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": [], "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": "094d3af4-61f5-4f5e-90ac-bab1abe3bc82", "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": "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 \"active\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"allow_prorating\": {\n \"value\": \"\"\n },\n \"product_id\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"preauthorize_amount\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd728ba-4c9f-4003-bda7-6554feaa6d43", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acf3b0b-2eb4-46c3-ba64-3754d55ed4e2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06624a1e-d833-43ed-9280-c1d8b9d08cca", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f8c604-aa86-4a2e-beeb-0d691f599e6b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d002751-63a1-481c-8522-496f4b690016", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a197509-b061-4e5c-bda0-65d45c7ac4ca", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2cdaf5-16f2-4821-983d-f86ce287c385", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1629084a-c055-4e76-ad2b-1b2f5a96eab2", "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": "8d660914-2345-498b-ba68-8733c78d29ce", "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": "30054ff5-3966-4081-9468-7a470e51cae5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132d3e77-4dc2-47b4-aefc-dace3f7ad6a8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45edad8-8f26-4a5f-be5e-5656abd7a0be", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee79957-c46c-4c80-9399-7babb21da573", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4955396-8832-477e-8278-96dd2904fab1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae674f7-d1d5-4546-bc3c-9aff4bce5f08", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "812b2d10-15d5-45a5-a081-eedf638216ee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a124d56-0532-4a16-83b4-66e1a45d62d3", "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": [], "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": "cb44d899-1305-4c4e-8bf3-e4c8e1ee90ef", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8458e94a-2389-43e9-a178-c566f2d3c5d8", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d497d4-53b4-4a7f-906d-07a63ab36afd", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1ba8f21-c0da-4a35-884a-1e5e2f91bad0", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "285fa15d-6dbf-4c26-b99f-e5ff6975ecbd", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96bd2732-86eb-40dc-a2f5-1ae09cf3922c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca5a24fc-3c4f-4bdf-ae66-fe6b2991358c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98797b2c-4c37-42e6-b41b-0afcd63bfc10", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4f760aa-6016-41b3-9599-15117321083e", "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": "7700b1f1-941a-47ba-a87e-a4073496605c", "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": "a65018cc-727b-4205-aa46-07d17c130b3b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43e23e18-ea3e-4d95-89ed-0ab0c05f07cc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc41a4e2-891d-464b-9b9c-27b45bdee8ac", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94ff81a1-9968-4d60-982a-74519103064e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5681de45-0d98-4a88-8b96-9bf62743e3fe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa7aa21-0f5d-47e9-89ba-0a4766a83694", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf9a86e-a696-4e3e-8969-d399e02b23b6", "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\": 1508,\n \"message\": \"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": "6e2543d3-a721-4f7e-bdcd-420d52b7f537", "name": "Payment Method Configs", "description": { "content": "Payment Method Configs endpoints.", "type": "text/plain" }, "item": [ { "id": "b045183a-c302-4e40-af1b-46bee587a887", "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": "fa3c2baf-a3f4-43e5-b0e2-44937d2c07dd", "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": "172632c3-e2de-42d2-b1ac-c053641620a2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2c5292-91b6-4b86-9fbb-3e356b6bf0a2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32977aa5-63bb-431a-901c-9c00cb94bcdb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53efc6ba-920a-45b7-8a55-45014087b79d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "577cba7e-f047-4f37-839f-4ed8ecd53950", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26506133-898c-47b2-971d-327aa4411e5d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "869a7ba3-8d49-4159-a194-423ac2123d30", "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\": 1508,\n \"message\": \"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": "0d05a63a-f84a-4ae4-bb8e-7ca35331367d", "name": "Payment Methods", "description": { "content": "Payment Methods endpoints.", "type": "text/plain" }, "item": [ { "id": "1ca18b1b-2671-451e-88cb-8877f4d99dc4", "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": "856a0ba2-2952-460d-8a6a-4bce60e149fa", "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": "50756fd0-b9f2-4364-a808-e537c0710526", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a7c330-7160-4478-96c6-c0b8f0b3c5eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ea411fd-22aa-4b62-b5dd-6cafa4f40dc2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c8b9410-adb8-4c82-b738-021beaa370f2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1feeee34-0720-435c-86a9-f6f8294a72a3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5ba215-ebcb-40f1-919f-bd28d59af5ee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "237d12e2-8e8c-4f67-bc6b-4e5f7733f8ae", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3679bfd-7335-4777-970b-e4654baadc5a", "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": "fa7f89c0-12c8-4552-8cd1-16e337ff1ff7", "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": "bcc68473-f1ec-4b93-ad58-1d29c4966184", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4cf3bc-1895-4b4b-9103-5a4d0d9ba51d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67db83c9-a2dd-44b4-9d97-b7fa3e7ef61b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a72bdf-055c-4cc0-be7b-262069f8ec80", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f540015-eaea-4eec-b3fd-ca5d362b0a3c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4761d6fe-71dc-4643-99a2-a25a561ec2c5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e4e52a1-d413-495a-8d65-5dc2e22539d2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a719e622-8eaf-44a4-9538-8caab8245aee", "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": "b750573f-3cc3-41e4-9d17-cf622e580f37", "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": "da23bce5-6ef7-49b9-a68d-e38d3399be33", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbf28a05-7353-4140-b40b-be5cf72ee22c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d7572f-e183-4f7d-b4b9-2d83ad3d40cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29c6e8e4-7f26-4942-bf28-69dcda358863", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec66a812-ae02-4876-b05e-a1e237419ecf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2586abf-3048-4237-ad95-43d8606d53ec", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a577b98-8cd8-4bf3-9933-360bf5855978", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c486c6f-80a0-4d2f-8521-bf028da5d05b", "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": "230a967b-bbb7-4096-bb0a-abd3136e3d5b", "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": "4292ba79-f115-4540-99f3-1d36ef9fe802", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d6fabb-e034-4ea5-9b68-63b2a6baceeb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "834be6e2-7000-4624-a51d-d3b5d7f87b68", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2d47f47-e518-40a8-b1f6-41cc5b2f761c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f766ae82-1b13-4282-a97c-3b67ebcb567d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac2b6ab4-4b87-42ae-a2a1-1500f0f0f233", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecfc5a9a-2fbe-4f5a-8b3f-d1dbc9d3f2cd", "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\": 1508,\n \"message\": \"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": "259db122-78e6-4366-808c-c6bc9e301ac9", "name": "Product Categories", "description": { "content": "Product Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "b3d14058-2b93-4f19-a2de-b3682ea33b0f", "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": "ba30171e-3164-446a-ba7e-94a51fccd1a6", "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": "bad01cce-4bb0-40b6-917f-24e280343536", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a0ba86d-f965-4796-b8ff-fe519240ca6b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b45d21a-9d3f-4531-be5e-5655b00f9130", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3413c4-720f-441d-a582-6a6822803324", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc682924-0d94-40b1-9e04-cd21c9b2a7a4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24c62aa-a57b-4f56-81a2-0f861eddc66a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "654b69a4-eaa1-4c18-acbc-84f6ed232936", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f010a21-8bb1-4b7c-8021-086a07246a47", "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": "10a83056-9a74-49cf-ae5a-ccdfee2f43d6", "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": "1eae198c-6b49-4231-bed3-21c563551005", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e034768-c11b-4a00-be65-4f18e76ad696", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0fefc3f-4e01-4319-8981-19693604fd18", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4deda2b-a686-44dd-95c9-6672fb310dc0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "002eaab2-78f0-4edb-a1c9-6d791b9a0483", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01965bf3-3c06-48ef-82c0-f42945fa62eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff805581-5ac5-4f96-88f2-475f3a122684", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57a9591a-aadd-4747-bdca-a1bdcf7c573f", "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": "c258b7cd-808b-4b4b-b576-4b709c8df24c", "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": "b16366db-e6ad-4031-b128-1d49852ed2f4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a977d0fd-74f0-4fb5-91a6-97aced21f1a8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2af22317-28dd-469d-ba29-db140701e6b3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4f4058-f143-476f-9056-c784b5e17d44", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf387ce-cff9-498f-9133-f6e88a9cc24e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd234411-bdb9-405c-848b-dfafa951cf5b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da0ac2db-917d-48da-851e-86ccf7885841", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73e2c01e-183f-495c-a1d8-f9e59557f885", "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": "40bc1737-2f9b-413a-9be7-a72b787c63ab", "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": "1ed8a018-d351-4120-97dc-034b617e1ed8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdfb9c38-ad94-4e92-9b6a-72d7af938359", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "366a62bd-fe98-4375-b80a-a468bd6dede3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052ed823-f6d7-4ea9-9b19-b3c00ad13395", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c86449-bece-4448-b6e2-b1ca93e713bf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0290ec9d-361e-4a51-ab67-46879d4b0451", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0cd0340-204c-4b39-a69e-378d6d4370a6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "335b877c-6036-4e5e-96a4-201fee0b9a3b", "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": "1372975c-c00b-4c8c-b49e-e007ee07bc58", "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": "144ee015-93ca-45df-8ee6-df2f7d531109", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c64651-91fb-43d8-94f4-06e266fa36a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95c5017b-83df-4ce9-9228-0f5226f8ee16", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da5b8e77-1810-4884-8aff-bb1edb332167", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b1318fd-1dc2-4532-bad7-4f18fb5b5070", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f3e98e9-6b0a-406b-8871-28d812c620f5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b145f601-5d1a-4ce5-a7e1-529bc6b115a8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8f571f8-dc01-490e-a318-ae0cb9373efb", "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": "64dbc3cd-3300-4cd1-b3dd-da086f1377d8", "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": "5f68e122-3692-4023-9a63-badc27d0c207", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a312dd7e-af11-4710-b3a4-173568058550", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "358327f4-a796-4b9f-ac5c-5976b0e2dbe0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c16f5d-7ac0-4fe4-b892-b2038b8f24ea", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44dc02b9-10f9-4c75-86d6-ccdf18eb916a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eecb0544-c090-45a6-b571-a3804091e3ee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6dc3a86-8ffd-471d-8bfd-83df30e6f733", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9acc86b-b4e9-4837-a8e0-f57c7239a2f5", "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": "6f12d72a-995a-4e06-8650-9484c0062edd", "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": "9506d839-dc31-4fde-8022-17d81439b229", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a3e68a-cf8a-43fe-a9f6-06e52cec3fc8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566734be-52f1-4f39-b2ae-f9eb6bbfc06d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e876c5d-bb39-4094-9a0a-2d8b93449564", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65c60e5f-5ebf-419e-8033-f8cfef295d69", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb1f0ba1-b217-4b84-9578-8018eb8e077c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f902b579-acbe-4994-9e92-16a0c35eaf8e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddfee6f8-8d5d-444b-92cd-45adbc311343", "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": [], "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": "53db260a-7822-4cc8-84c4-5a7c93c3bfd6", "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": "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": "de3b63c2-7882-4306-996f-3cb8b7cf14c1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1da389de-0718-4b6b-ba06-701e09a47b00", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4de8958b-d68f-4372-869e-dc4cc66499c4", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "935dc575-0758-467a-aa2e-e623d42330fd", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df052ba8-0106-4383-b1fb-833424a1d285", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1303fcc-8395-481c-be04-0aa2bec7cb45", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "808522f6-1af6-4d45-9564-2839aecb3b6c", "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": "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\": 1508,\n \"message\": \"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": "61902aa8-5028-4a77-8ad9-633120b93e33", "name": "Product Discounts", "description": { "content": "Product Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "8b98debd-a197-4818-bcde-3baa168de09e", "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": "2a93f594-d83d-4862-84b1-12e9152571ba", "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": "ae591412-eff1-453e-b4d8-f2fde7099162", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bf34ce6-806d-4340-bc50-98dec3d9242d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96f2145c-5ca8-4087-b494-9085118f8ef5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e9b35b-2c0c-4206-840c-d60936025362", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcecf25e-05eb-4dcc-9040-78d99a02d674", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec108f27-3581-4c24-9786-c3b21d63cd57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff01ee6-5802-4985-9019-3d4ebf356a4b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf9071d1-30f5-4b99-931d-0093e2e5288e", "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": "2cb8c93d-2305-4be7-9768-16a9ddd87189", "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": "73028a7e-4301-4449-a884-8c3158feb775", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c6cf01-9d41-4fad-a07c-c0ac98182d05", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94459f45-b875-457a-8951-68cc97bad326", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c27e8f43-da7b-40b1-87d4-ac249de7f839", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e9a7a8c-5b56-4d18-bd5e-cebba40a838e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001e41ee-d659-4ec5-85ec-bbaf5eb92a54", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4194a074-72f3-463b-a187-959bc1d832fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb6a2600-9431-4bb7-ad0f-75122baae3ec", "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": "92abeadc-d679-40b6-8e87-542ef37d56c3", "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": "507a1846-ed8b-400f-9051-82b9ca17f8fe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628baa3b-52d4-4b3f-80f3-979ccf34d465", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ac27c49-a3e7-4af0-ac91-3338712fb6be", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3066f8d-7080-4b45-8d9a-fe669324948f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f25809df-22a3-4825-8afd-4e1bc59a5337", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0909da3b-6f56-4eda-9e47-d7cf024d5ec0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87831962-57f5-47fc-a64c-0cc359546b68", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8dcd7d9-76bd-4346-99dd-cd65c02873dd", "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": "f87c3fe1-5155-41a1-9ccd-a6ba17bd3c83", "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": "7393010f-cbb8-4eaa-83ba-1687a46d9468", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9f52e37-8345-4d71-af75-1af757c29368", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c816844-8a4f-42a3-8f25-50b969ee34a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "254c7b64-0581-44d8-b6c3-a49a0bd56cd0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d652cf-a9e7-405a-8ec4-a0857b76ca3c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8775254e-a0fd-4511-8e5c-ed7f969f9648", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d5b2de-6a6c-4754-81ad-ab06f2e92a9c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "026ea57b-67cd-4c33-8f06-9cd60bb9f481", "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": [], "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": "9df2b49f-e95d-45c7-b8ed-b8bf38f7c769", "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": "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": "49d9ee62-bd12-425b-979e-2989954b0430", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077971a5-681c-422e-a1a4-e95715db929f", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "364452f2-1d65-4d4d-9753-6a107eacb442", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f584039a-4a25-48dd-a7b4-fac2a8bbc5ef", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb9a682-5fe3-4b80-83b8-44f17ccab5a9", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c463f7ec-05db-4b14-91ff-991f49bac440", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55074648-71e8-4a80-82ce-b3f1a6d01b06", "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": "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\": 1508,\n \"message\": \"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": "24de457a-aaad-440a-a48e-1897202348cc", "name": "Product Interest Bundles", "description": { "content": "Product Interest Bundles endpoints.", "type": "text/plain" }, "item": [ { "id": "5491dc52-2765-493f-8e64-5339114199a0", "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": "b5afb970-9274-4d8e-bf2c-985c95cbf370", "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": "b3e4cb4b-1849-4767-ab1e-7c212c20af68", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fafcbc-e276-451f-bac6-f2f35ac6fc9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a91233-4f11-4ddb-bfbd-cffe604c5687", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fddf54b2-4f83-47a5-b792-3a23f407bf96", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1490e71-45dc-45b0-9f97-167571c99a62", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d93fba-6e68-4148-a4fe-9c564e3bd196", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "007d51f8-1ba7-48a2-92a2-13d91563bd24", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d38c975b-68a4-4fc6-b608-927e045c4134", "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": "a18f6f76-977b-4e7e-b334-c0686b21c35a", "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": "ea93afe6-e3d2-409e-bc5b-7f407fb0a12a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0eef2cd-ca23-4595-9fe0-a2ea0c13ca22", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd9ab67-8028-4ecb-bae2-e873e119d2d7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4768d15-374e-4a2b-8567-08299428701e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80673612-8b7e-402f-970a-2e407f545453", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1b0d843-aacb-4d08-a3e7-30a6fc961312", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68163751-e166-4509-a9ba-ea68897eb46a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd20a796-292d-458b-8107-2860777951fa", "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": "fbf8ba67-5d51-4287-90fd-f84e9979d3e4", "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": "fc26d5a6-715f-4179-832f-7133455d9643", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1107ea3e-a2d3-44cf-b6e9-295095f7f0ea", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e621de75-b94f-4983-9287-f19e3ab85b92", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18b5bcc2-3cd0-4cde-a0cb-3ac6f0ca752c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f2de635-cf56-46a5-a3a9-636aceb030a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee40bd9f-2cf8-46a9-a0a8-e38d6d1bc0c5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "908e4589-22e6-4564-b749-9c580527218d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9c43adc-0b71-4a3e-8369-2bf70024ab4f", "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": "338ef044-2e35-4e84-b982-2a998a97d584", "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": "52486b29-2271-4093-844e-1e019b20ce73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e169e75e-eab0-4f8c-95c0-c175a54e346a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ba75b5b-33cb-4b5f-9559-8dcb45727f34", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e79083-6251-42dd-8206-513cfdc63973", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1108a0e-1b88-4e84-aa37-3134ed4b1c7e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd4f5ac8-dc68-4aac-b568-c8b3e0bceab1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ad692f5-d575-47ed-b745-b3c9663993a2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e5c4779-07fe-4e5d-8e66-1d6f163b15b1", "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": "e9f51a4d-2e94-40e4-be21-32b2a5cc38b9", "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": "7400eb48-ecd1-49ef-a75c-4c989e66fb24", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "111d537a-a85f-4f4d-89fc-146296ede054", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa709281-2beb-4ffd-b330-2cd17d1ce149", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bf4a01-9178-4b16-92fd-26ff68e33a77", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c8511e-4894-41d9-abff-f57432ee7157", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ff8104-6ee0-4079-88cd-84ad3fa23eee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3833b02-b256-426a-a8b3-477831160669", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7b0a671-d712-4ec1-9168-1422b93b9a6a", "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": [], "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": "d7b03b82-c6de-44a8-91b6-12600fc55f59", "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": "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": "24d0b7d5-f0b1-4bc8-98f1-30d556640833", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfe5cb6d-9d4c-480d-958e-a1de995fbb46", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c67fe4a-ecaa-47df-9869-0525ae61fbf8", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a4b7ada-6cc7-4576-b484-ec2470647e28", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ebcf44d-9b27-4a48-ab40-19baa5b434ea", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14864e80-15ec-406c-8896-8d162b1d11fd", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98128f49-d30d-4972-ac1f-b1a396a32e5d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6182e47-cc97-41e0-a93f-a73814a1d35c", "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": "042b7bba-fe3e-411d-8d7a-f1ba5e7d8544", "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": "35304384-a863-4304-a66c-6f0eedd0fd60", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "531fb037-2f2d-4229-af72-9bc58b3e534e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a36186-0404-45c5-9d25-a772111376c8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d00fa345-8513-414d-947b-ec457a8006db", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98b2aa9b-a894-40a8-9c8c-cb0ff7dcb471", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d53f4f9-d000-4d3c-b5e7-6687d4978ecb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8305166-f09f-445a-8207-d72ab48ff33e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52424607-7944-491a-b3ce-faedb59f8a01", "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": [], "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": "24b823ee-f0dc-4755-8566-0b17030fce05", "name": "OK", "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": "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": "9845c253-e5c2-4fff-a89f-380989d2f35b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca364456-1455-464c-ad9c-4b07f03af44b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f285a22b-8fc8-49a7-b988-ffc1e6b9b863", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8294b9cd-0845-4ed8-9d7e-06ca07fe3d8c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d183da7c-c478-4a18-afdc-cd3953d197bc", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f09a496e-3912-4f24-8daf-55384b6d22da", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc4f2026-c7df-4e94-a0a8-e5e75504f7da", "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": "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\": 1508,\n \"message\": \"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": "f11c835d-1709-43d2-9757-d770095421a6", "name": "Products", "description": { "content": "Products endpoints.", "type": "text/plain" }, "item": [ { "id": "e0848a3b-33db-4170-a3e1-cba4a871a54c", "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": "2ec84595-0862-4f13-9cc9-161b1bab9728", "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": "60620853-033f-4e57-abf6-786dcf355f44", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd6b719-cc5c-49af-a108-2db42e515e36", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c4726b-3b2f-438f-b6ff-229afac7d008", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2752f558-460d-431b-95bb-f133061d4f38", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ccd909-349b-426e-a346-fa6e591957d2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213bd3b8-5ecc-4255-b6d7-b5d8b93652dc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d7a8eb-85d8-4141-a30b-dde71ad8069b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29d3aa8a-ada8-475b-8c19-04f50f493d0b", "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": "01bba72c-8c3b-4f05-83fa-71fec1522094", "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": "b7ed5673-0bbc-4947-a091-c154d521d3ad", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24b8917f-4388-42af-9f0f-6563036e3f6c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90ba8f80-71ef-4054-bd06-0e75b0cee4a9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0319792a-b523-4ce4-ad7d-8e6b774dc658", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba37f120-1a16-4dfb-a693-1a20406d398a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c3cb7ba-ed48-4f8a-bf97-72b9921ff89a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df587253-9b95-4cdd-8778-8921c031972f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bd34f38-e32c-4d2f-b74e-0731ade9837e", "name": "Adjust Inventory of a Product", "request": { "name": "Adjust Inventory of a Product", "description": { "content": "Increase or decrease the quantity of the Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20e28c7c-9c9a-45fd-b8fa-491ae286fe48", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\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": "08eb346a-0b32-4e67-aefb-3d8003e0461a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2b15a9b-00aa-4211-9c96-3eae13ce56c2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ff3a7e-807d-4293-a346-4a46dcc95ade", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17275bee-2c46-41ba-9fd7-a35d39eb2cba", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0368983-617a-4a44-8359-d2eb85089601", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e6e139-1aba-4af4-b478-379938b57e32", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12a2b506-bc57-4118-99e6-30e5ff8e9930", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 1299\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2e91110-0a37-4b81-a2e3-49ba9eb9b2a3", "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": "7cd19a44-9116-4b20-ac6d-06ea4a929d85", "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": "d3b848c3-bf97-49d0-a50c-834e89e346de", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1916f5a-6d55-435c-b064-645f18b27553", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "797b1492-b8c9-4bfa-80b2-e1a40c6a718a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bef7bc6-1917-4c01-ab1a-96435ace8a77", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f0782fd-ab54-48b6-b42a-92df0ab2cd46", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d659e67a-1b75-43b2-acb4-8edbbea6f17d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4d6fba-24dd-420a-bb5f-3efd87145f25", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57e25115-6028-46d5-8941-3322244e8b54", "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\": 6390,\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": "140a2e07-e86b-476b-b6dd-eab4aedc156d", "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\": 5246,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 2573,\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": "24552d51-5762-4daf-af95-65791004f560", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d01cecd-09ad-43c0-b49e-6d9b8fb6703e", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "605c8908-1e60-4455-9a94-c14b6040e399", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b161125d-4f08-46b5-94bf-d3c70e987819", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bac32965-905b-481c-bcb6-7f4cd2188c86", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a13847e2-28cf-45dc-8ad0-a7e34b36279b", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee752bb-f98b-4014-be5f-efad209e3379", "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\": 5246,\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "809b5b0c-c8a3-4a4a-b0ea-9c768a19854e", "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": "d0792c61-caa5-4899-b4b6-02edf1f948dc", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 2573,\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": "82ca652f-b392-4f29-970e-48ffa72b2f56", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96189930-07bc-419d-850a-3988e0536172", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9ce0524-c0c7-44df-ac75-22746cce2d14", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44497c22-8b86-40fa-8470-7d314bfb33c4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a39a14-6d9a-4dcb-91ab-b27f0cf8ce00", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d36b923-f44c-4792-a947-71b116248887", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e2f1af8-1553-4ee1-8136-182a6ca473de", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8afaf0d3-681b-4a2d-8987-d713c517510c", "name": "Create the Product Image", "request": { "name": "Create the Product Image", "description": { "content": "Creates the Product Image file and uploads it to the specified Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "legacy", "value": "false", "description": "Set to 'true' if the product image should also be used in legacy cart features. Only one image is allowed. If an image already exists, it will be replaced by the current image." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) The image file to upload" } ] } }, "response": [ { "id": "774a1446-70c9-4e2c-8734-523f76085097", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f415983-26d4-402c-a9b7-0489b583abb6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9490aa34-1bc0-4615-8204-46b7a22b41c5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34137cc0-1683-4be0-9af3-83d0dc8d3822", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "200aedda-f3f5-4123-b182-6281ddbe648a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06e03b3c-8949-4d9a-8296-f1e17eb901f9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aceddecf-38e5-4e06-8ba5-d6bb9c35b203", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a9a028-f4b3-4ed1-9f81-289c51e641d8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f93368ee-57c5-4e62-86d7-ef3490cf63f8", "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": "39477723-ffed-4b33-b4da-c98e0d66da25", "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": "71da749c-a08c-4ab0-bf57-7d50ea4069c3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e5b4d3-db49-48c7-a0ac-0df308f957c0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85f7417-d015-477d-baf0-8aef27e25d75", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59722851-9c6e-4d09-bff4-000d809cef46", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6434a1e1-e98a-44ec-ae06-e455069492ed", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed1fc02d-b1d5-44c5-9214-af6a81fafdd7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03d8da66-73eb-4a77-bb15-e0bd8b9bb613", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90402ad1-1bb3-416b-a269-83258d371721", "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": "dc0316e1-c3d7-48c4-87c2-83c2503ecded", "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": "9c885f91-1f45-4252-8a55-692168564474", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbcbcd77-ee0f-47d3-a848-eacd5446517c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49202826-05a6-493b-8508-b4f42cd27b46", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1a80c05-1119-4738-9be8-0b851642e4f2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfbafca-398b-4397-a369-526c50e88d56", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf1569e-1601-4440-9c11-617cc6469af1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2647cd71-7c2e-4f2e-89e5-20396bf9be38", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23860692-31d4-4b53-8fcb-18eb32fa3265", "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": "0be7af49-8976-42dd-babd-24a1cb7fe9f5", "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": "92806c38-6131-4579-b585-a0255bb89137", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe2b8ae-9bbb-4f9d-a2bc-75cafe97e4cf", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69b11a0a-ddb9-4ca7-8d3b-1a125d8eb512", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2107f548-51ef-42eb-ba7a-a65a907565d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff4aaa5-251a-456f-83ad-0b0da4979723", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b02ffb3-f394-4281-94e8-b86ba985c658", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24705300-1189-4b75-a911-d9b89b9fc2f3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90bc8fdb-e21e-45fc-9506-ec5ca8b54dc0", "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": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b0c0d0b-06fa-4cc0-a24a-bc44c6c71c19", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": 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": "d19335fd-0575-46b4-b708-ec2efdffd2eb", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df024b85-c913-47e8-82a1-384f6239d01b", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5233ea9-959c-40ef-8931-25b732631e78", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01315d0d-14b3-4b9c-93f7-226b80b00dca", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40d7a23a-6a35-445e-9148-1cff2e1865e0", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a6d219-26ca-467a-a7dc-d32cca5f23dd", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e34fb0-346f-4be1-907c-c6b7f75aed10", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "343ee4d7-1a95-4d63-8e9a-57a7967fed0e", "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": "82a2c98a-9115-49cb-8480-35fc7379e50a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 2573,\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": "85dd6542-4e60-480e-843f-a0d65d3afc97", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8247d45-6cb2-4bff-81f9-6fedb39581ff", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cec209a-7a10-4d63-a433-c47c04e97e16", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3e84653-7896-424d-8bb5-1685d5ce92c4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9157bf-2fe7-4113-9568-911b534eaf24", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d5b145e-7f45-489b-a902-ae1514439adc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfbac731-7155-4668-b6ee-fdd75db93cb9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48fdfef3-a06d-4c24-85d8-c794ecce2a0f", "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": "4284a572-449c-4126-af35-c6ead8b5f654", "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": "aa414ab6-5f11-4ea6-a126-b770fc5af76d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5504cecb-8067-4fed-8b22-baedbeaf3524", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f63f7f2f-7b9a-40bc-ac65-d20caf9f136e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab6e020e-ceb4-406b-bd71-104ee999ff28", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f129b064-51fd-4998-b510-1301dd7ac6a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "478a6f40-268e-4a87-9812-7e81322f91b5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "158303a0-ef0e-477d-90ea-58303e6fbe84", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ff54bee-91a6-49fe-83c8-b92ee3c51772", "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": [], "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\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7402ac25-e50a-4400-bd01-ade1df459248", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": \"LIST\",\n \"display_order\": 2573,\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": "93507755-d505-47a4-88b0-8c8c71844516", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5202435-7cdc-439e-818d-fb5542b48de1", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6c69b59-3848-450d-af00-7ec30f7963d8", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca76f5a5-bd7b-4ec7-8cb7-f1f1c94983df", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280a00c2-b5e3-4b14-b069-f353ce5b2c9e", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bb08dae-ddd2-47e7-ba59-e4a73fabe9ff", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b312baab-b04e-4b0e-bfdb-96e39a0e5a19", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 1056,\n \"minimum_characters\": 188,\n \"maximum_characters\": 9930,\n \"allow_spaces\": false,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"LETTER\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d27dda72-782f-4db0-bd35-2327cc3168bb", "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": "717d895f-f6a0-4319-9304-65b38ec38217", "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": "2c50a2a0-3dce-4c87-ac77-f86aefe27e0d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "316d66d3-6dcb-473a-b446-f125aff6f7f5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cdfb644-0630-41e8-a4eb-d5a01deea87e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55159593-2b61-4d42-9c0f-7e723d9b9253", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052ca59c-4136-424f-8d69-03a324a9f4ae", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cac9db7-4bfc-415b-8ea2-2eef095c363c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a50962fd-6d73-4e6a-9df0-70c26cd694f1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a236d840-318a-4200-b913-bbddba3f98b6", "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": [], "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\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b10445b1-f1a9-46f7-95ab-7435a8ebed91", "name": "OK", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 2573,\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": "8b440c74-fb12-44aa-bc51-0d60f21c5ee6", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6f48b8b-e07c-4fe7-a50d-818ad5529291", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c0116ac-ab64-4cc0-80f1-16a6b3b0df99", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "742783fa-edd5-4604-afa4-f18fb1b1a4e4", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7686dc-d78d-4a10-a3d2-39fa742d3221", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093ec82e-4019-4595-9121-841212d339a0", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9884cae1-0657-4fcb-9d88-1260af1b78d1", "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 2181,\n \"price_adjustment\": 6736.597497389805\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0d40f04-898e-422d-befb-20a54b99760a", "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": "4a9654aa-dac0-45f5-8b31-44401c3a66c4", "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": "d67032de-2b5c-4d44-becc-bb08393a092b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f5f00cf-e2d4-43dc-b092-4bec492a39e1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "868b96e0-b9c0-4866-be7c-d3ceeadb8d9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68744e99-9bd6-4361-bba3-dcf2d1c1e834", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e4aceb-bfff-400e-a1ce-ed4cef779b1d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8bd964f-f5e1-406b-9036-30cd16fab847", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6693b65e-3713-497c-bc67-1f65ce9d4322", "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\": 1508,\n \"message\": \"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": "3ae8416d-ccaf-4f76-80c0-0436cf8d6703", "name": "Referral", "description": { "content": "Referral endpoints.", "type": "text/plain" }, "item": [ { "id": "89c81836-75e9-43d5-985c-eebf58bc3603", "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": "00f46925-9a83-4f76-99b5-5b13dbe8443f", "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": "62aa604a-dd37-402d-b57a-217107de4dc4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27df51dd-67ea-4e39-94b3-6b34c1cbce30", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db987ec9-8ee9-43e6-9323-5cebacfb1bc0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0370819-5a10-450c-89db-b2826884d40c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac077fe6-167e-418c-b5be-5c7e05a6439a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cda95c7-e511-4474-88d3-2443d2f7ea06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eef1f906-cd74-4f5a-a9f6-4971ba21fed7", "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\": 1508,\n \"message\": \"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": "7ae1bf10-8b89-4a7d-9816-da415e383814", "name": "Reporting", "description": { "content": "Reporting endpoints.", "type": "text/plain" }, "item": [ { "id": "ed952796-eb8e-4a9a-b170-dd809445c811", "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": "8038", "description": "(Required) " }, { "disabled": false, "key": "fields", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "1f10afaa-ba45-402f-9291-baef1773ce30", "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": "8038" }, { "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": "a0199a2d-9af2-408a-9813-e7c81ce53f75", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e37ac7a-5165-40a1-8c1c-2ab1ada6b86f", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af7bd33b-5169-4fa3-934e-be4823797bc0", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d0e3db-2ec4-4117-bb42-cb8d8557a48b", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46082c1b-9fa6-4a9c-9d01-fa0fe879f42f", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10218d6e-853a-42b5-901f-019f27f3c1ef", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88132748-123f-4150-b82c-40bb0e77002e", "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": "8038" }, { "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "193b8e81-9a00-4746-a40a-d07b68b8f6e4", "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": "5153f78f-8f0d-44c4-8ed2-aeead5363ec8", "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": "344faa4d-2bf4-4fa6-a3ac-1fca7d17c043", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "072ed12a-9ee8-4d06-a3ad-86360a795296", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "090608fb-cead-47f6-bab3-79c54023338a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7cee45f-1cdd-41b7-97a0-b0fed7c1c960", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b9fdc01-fbe0-44cb-ba47-7a6c09f9ec39", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e159766-1ca9-45ab-a503-ec061423910c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b27f7b9-d9ef-46ed-9bc4-32449a1b2b02", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c06e4380-310c-466d-88b4-2abdece96fd3", "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": "d2764918-64f3-4b92-b785-c0399818e409", "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": "964d08df-4b1f-4a0a-b471-05bd8ae9d7bc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "855fc61b-24b5-42c7-8611-b6eb589c15ae", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4f378d-a6a7-4dbe-8ed7-96d779adcb39", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d47eed5-bf62-42d0-9ce3-aea374656bda", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbf32be4-8e4f-41c7-85b0-97a5e3a5b316", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a16e27d1-1f46-40c7-a78a-15b1296897ed", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e117169b-37aa-44e7-abaa-583c3a16c932", "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\": 1508,\n \"message\": \"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": "890a1500-6a50-4416-aecd-fc2fde0591dd", "name": "Sales", "description": { "content": "Sales endpoints.", "type": "text/plain" }, "item": [ { "id": "15164a8a-38bf-4bbd-9b8e-cdc3fb50f5b4", "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": "d6f04ca0-ee93-4bae-8099-a3c650ba8120", "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": "d0d0757f-914a-4539-9498-87265a10add6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b0fcc69-855f-43e6-9b27-e43d4a110c62", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a10ad4a0-595d-4af2-af26-f106def6c25c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d79f1d1-69b4-4cbd-a489-644e37c2caee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75efbbd2-000a-4231-b0ee-fa6201a0da4d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c169c14f-72a1-45be-b6fb-5fb388eab0c9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed171e8-39ed-44b5-829c-d339a0e1fb2a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4e4b6c5-14d2-4656-ad82-503d8022bc77", "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": "7f3f94d7-5e38-4a3f-a138-34a05e72938a", "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": "d20eab13-14bd-46b6-9ed6-76547928dbca", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26e2db17-a95a-4a83-bb02-e674c2d19a3b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b2906c5-68c0-4f00-9c48-8e9bf65d8304", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8567796d-d37b-4268-8868-1932c380e270", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8936b05-ed0e-4bc6-84e4-70bf6df3053f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02c1b5f3-d02a-4fe6-b391-fec933afe2e6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7c31c95-d8bf-4348-a7db-03c1d0fca1b8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7be5b6e-ee12-4847-ae37-bef7775d2259", "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`\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\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=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- `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": "d3eec956-c5a4-4a39-8259-0838f0c1d171", "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": "45581711-5cc3-4ed7-8328-d421759ffd57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "febd3fd0-806b-4556-a875-4ac39b013794", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99cf68a-5172-47a9-a3eb-db4104fdb859", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9986aa5-9a47-4fce-91cb-22dec8eb51ff", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d04fec33-079d-44be-8ec7-69cfc5db298a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "befeeb36-a48f-4090-8e4d-2ace5329fa18", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6936be9b-679f-4957-bdb3-f34a148df697", "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\": 1508,\n \"message\": \"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": "001c2bd0-e00a-40af-a96b-d7bd42b04d14", "name": "Settings", "description": { "content": "Settings endpoints.", "type": "text/plain" }, "item": [ { "id": "7a422020-97cd-4b6d-9382-c8a2443c7d89", "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": "03036f62-5a84-42d7-85d2-dd90205cc17f", "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": "eb1369b1-ecd7-49fc-80dd-0eea52105d43", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e40bea58-c81a-42da-84f2-8a59fbf29459", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "645daf13-8e76-4b02-bbaf-63591007a6e9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40fae913-4eb5-4122-8edb-de036949811f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83ceb8cb-aaa9-4f54-9671-3b3ff7636139", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f38d7dfc-8678-4469-9dcc-65ad977743b4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e014aea7-8966-4926-ab7c-80e7617e7909", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b525b572-4824-41d7-b55f-b379d1f36783", "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": "1e8a9787-eff5-400c-b447-82d485748caf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"isEnabled\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6873f5dd-4a3a-4dbc-89f0-23a6d5109603", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50012684-07a5-4fbc-9181-0d843fd5aa35", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539e990b-b25a-46b5-8f9f-09706ed9f420", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce5c7a7f-dcb1-41fc-800c-65758920422a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab629d01-522f-48a1-a1a4-0d8ad2b5d09b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec5acad1-621e-4146-bc9b-3dc9197548fb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff02f83-53c1-4113-aaa9-af9070a56f78", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aee655d4-5a77-405a-a873-222a02370b9e", "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": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d1c8891b-7bd9-4436-ac87-778170bb51d3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "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": "5e9bbe6a-b616-4bf6-8304-e3d3f652f80a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2316022e-6e9c-4820-ad7f-783e953b93e9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f5c82a-181a-4d77-9a0b-85d377d18025", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5289c55-e263-4189-bdbd-03b4c0d85a6c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "661fb333-5834-4241-baaa-36c52a623cd8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28990cd1-8498-4975-8876-27f35c50460d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "508500f7-01e5-4c6f-8d29-0a78c7aa9f63", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"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": "e6860eee-8827-4b19-9a22-13fa8cebc92c", "name": "Shipping", "description": { "content": "Shipping endpoints.", "type": "text/plain" }, "item": [ { "id": "996aa493-5299-4a96-93f7-82fdd2a4aeb3", "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": "d77c92f1-6171-4274-9da3-8a151b8f40b9", "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": "0c0e0cfd-32fc-4255-9dc1-5e53c54fd508", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0b0779-8bcc-4df3-9172-c7bb3a87d07a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2876b432-4ed5-4e8a-b694-52a4d73f39c7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "763e6552-c289-4169-8cc0-755f04d5a491", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f35a2fbd-4090-4899-bbfb-45d1a4f2d353", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b67c64-2beb-4bb5-b5e9-cb268ad0a91d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff787836-adef-433a-bdb9-67c2445e2b7d", "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\": 1508,\n \"message\": \"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": "22163a79-b702-44c1-9bf8-408268da14db", "name": "Shipping Discounts", "description": { "content": "Shipping Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "a5c90803-adae-4e0c-b6fb-b69bd2cdb8cf", "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": "feb04c37-c2bb-4a1f-b86f-e2ff369589df", "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": "d0da6062-590d-4f71-af47-5459071e2e6d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fa365d0-f5b2-4a32-8236-74268df488b2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d3e3f9e-8925-451a-be5a-00b66c097a71", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53748a1d-0790-4b82-a429-63d8adf62616", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96cb3432-dfe0-49da-9494-c101cca1fab1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff32cd1-06b6-489e-a620-e5bacfc4fc04", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2267d49c-e08a-40fa-8a95-20123fa35c5c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24593a6f-c7c4-41f3-aad0-616517180bbe", "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": "dc69c0fe-6763-4a2f-8315-952391e36f63", "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": "05b01ecf-26f3-4aa7-900b-33ed72b7804d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d330576-b11c-4220-b96f-e30f544be995", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bdc48ab-604b-4bfe-890a-8a45653ef343", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c50157-85f9-4dd5-a3dc-259c627c6ffe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f27c852-9194-4390-811a-3966805e291e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a084acc2-40cb-4405-bf6e-f0b28f4d0809", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2562350c-f7dc-4b30-a75d-002d8d949f0d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac31bdb6-a270-4968-8853-66cc360076c3", "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": "b7e3a774-d178-4f1b-a659-3bd93109618a", "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": "624d22cd-0099-41f2-bb8f-6b16ceba43ba", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c8354e3-da5d-4bdf-8ae2-5f80e4a0db50", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e08afe6c-6b12-4573-9afd-cde2ef48925e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f496e99-bdde-40fe-9328-07df95be8d1b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e7cead9-bffd-4c3f-a5a0-3d019e6a27fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8daa534d-a06c-49c6-97ad-bc1dce3a2f17", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceb72a37-0e31-4503-baea-4ee4de06cc67", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b117479-8ca5-481c-8e78-ec46c273d548", "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": "b3e4002b-cc80-4263-b986-ab53676e0954", "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": "6497119c-9984-4ce6-ad68-b09cfab74993", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e61c2e9-7b5e-41cb-afcd-4ff7fc0a06e4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e8230f-c85a-4c6b-974a-b8f120c5c156", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30c29fa3-5cfb-4e24-98a2-6f5d099f8258", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13fcc8ca-012c-4fa3-90a6-068268da341f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41a34552-06af-46ef-8773-90b1b8dee49b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "259a7ea1-976f-41e1-80b1-34c239764f31", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f01d9c9c-ba1a-4e9a-8fdd-e94f9cc7239a", "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": [], "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": "25a59941-51e9-470c-8b02-0d378d956653", "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": "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": "4d1ac86f-9d8e-4bf3-8162-3e6d429c5a90", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dabf8e3-c85e-4774-a45d-c1273a2849a6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db1dad7-cbdf-4d28-9f92-4c3d29a9b64c", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9274a9-fb17-47aa-a0c4-dd3dd48bd71d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cfaf381-fdb7-4018-9d34-1259670c134e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e854f4e-9e9c-4a4c-b9c6-f71d55214df6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f2d68e-24a4-4baa-9fb4-b0add879cfc7", "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": "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\": 1508,\n \"message\": \"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": "7172b69f-d678-4af7-883f-31f83bf766ef", "name": "Subscription Plans", "description": { "content": "Subscription Plans endpoints.", "type": "text/plain" }, "item": [ { "id": "67477617-5002-45f5-bda8-1511b8831f11", "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": "7e44e0bc-f5c5-4d46-8d64-2cf62f6db86b", "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": "37e094fb-8a27-4848-9d6e-bcf655db7c57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a767ec9-771e-4cc1-9b4f-e59f681abca7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dec89f5-26ff-4d7a-9e84-0f092e2228dd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64f21413-9e8b-43e7-8cb6-fe5f1f89e0ff", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5702a08d-182f-487c-a8f0-85012c473d85", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9509e7e-4a0e-4955-bf67-50ed9fb2f2fa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "669374ca-c914-4951-a93b-f5b4ea4b9404", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51cf1a9d-d2e0-4725-8336-977d746e28b7", "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": "3f5be4d0-26d8-4887-b256-0ae3717da303", "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 \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"product_id\": \"string\",\n \"cycle_type\": \"MONTHLY\",\n \"display_order_index\": 0,\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 \"preauthorize_amount\": 13\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ba00e6-e518-455c-a29c-28442f7023b3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a0ee42a-e040-4f9f-8874-d29b5f30bed6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0138df6-a9f2-4bfa-96f5-62866d2d2f80", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e6c158a-94c1-43c8-b2ba-4c879c99002a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e35003fe-7fd2-4675-b06e-b5e0e9f9b613", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf49d5c-ad0d-4a06-8890-b6ce1daffbfa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e9b4d3-5f8d-4c35-ab90-4e4c07a49745", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fffa25d6-90f3-4af8-9858-c5f9acafecc4", "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": "b6181e7c-f575-4391-a5c9-4cae629f9794", "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 \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"product_id\": \"string\",\n \"cycle_type\": \"MONTHLY\",\n \"display_order_index\": 0,\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 \"preauthorize_amount\": 13\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9734b57-eb79-4e4a-b0d2-07b9f0d89c87", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d537c24-17ff-4a4c-877c-c145e89b396c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd30a9c-38df-495f-bb7d-b6951e272904", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e0f22f-6ad5-44c1-810c-43594c9dd389", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c09c183b-55aa-4b1d-b86d-ffc94fdc48eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44f3c486-0482-4d52-8b83-0ee12b61ffa4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f77231f-dc78-47c5-9225-26fa864bfb8b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "577c0150-8a74-4a39-8593-df56bffaa35e", "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": "1ea3e330-2e76-44c4-9666-653ce3db8b04", "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": "18994db4-7b34-433f-a21f-8235343c2d45", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ab9c49-090e-4b8f-bdb0-d6c544404723", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d3961d2-86cc-4003-b9c9-63f4e7c5a95b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cd02ba0-700c-4699-a59b-262f8a7d9e9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da6c5ab-19e0-4fa6-96f0-add140f4f540", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610ba189-ce7a-4459-ba5b-3286b7650b1a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59463d5f-c205-4927-ac1e-e1e010d9f99f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b825e79a-f7fd-4fae-87a1-78c247239306", "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": [], "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": "f21213dc-888a-4881-a056-0c87ff825e26", "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": "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 \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"product_id\": \"string\",\n \"cycle_type\": \"MONTHLY\",\n \"display_order_index\": 0,\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 \"preauthorize_amount\": 13\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fdd5b76-3c9c-4a96-b18a-6f9cdfefca10", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec93e346-83a1-490d-93af-2d36ae51baa2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c2d1533-a8a1-4dca-ba7b-90d773a4dd3e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a25a1f-9db1-40f9-a53c-201775a393e2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07e689d0-3d43-4f41-93e4-a1ee7121a847", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0324ead1-5165-4eff-bc87-9428f036ed25", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d60c10c1-867d-444e-92cc-f0a779432f11", "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": "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\": 1508,\n \"message\": \"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": "9265e41b-035e-4f6f-822a-1c23a68a1087", "name": "Subscriptions", "description": { "content": "Subscriptions endpoints.", "type": "text/plain" }, "item": [ { "id": "f7cbf61e-5d7a-4423-9337-e8063d016b19", "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\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" }, { "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": "c1bdc48f-6a39-478e-b260-eb744db0e593", "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": "f81421e5-5d90-4a7e-92e4-c1b7197b6ac3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99d65f68-1d54-40c9-89cb-9fb340b5449c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f34d7a3-ee8c-458c-90af-8b33ee594a4f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb5f268-a980-44cf-82d7-9e490c3d24af", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "002c61fa-222e-4754-bb25-997d9f8096fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f763efc-fba7-454d-9b16-7464e4b8e1c7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c9eb91-bce8-43df-a080-6a47dc006960", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8fce851-2def-4084-8ae3-f92942522301", "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": "1b4b76c4-a44d-4fba-9a8c-7162dc6deeb5", "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": "a63ddb1f-1f0b-49a6-99ed-bbdace760c6c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f14f10-9fbe-4d72-b28b-fc6a08037253", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113beaf6-d2d8-4bb7-824c-ab215adf0526", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0c06387-9191-4832-9c65-2c4d29388cc4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81a46513-ed7d-476b-812c-52ab89fd098c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b19c7e6-a6a4-44d4-bf17-dd2c9f2b967f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd17d34a-b105-41e1-a7e9-f7e495b30f9c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6cc29cd-cba2-422f-81a2-9651a2185b22", "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": "9ab58818-0f57-4182-af38-0dbeae5577f6", "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": "a2c41fd4-4c4e-4411-82f9-44b66bfc1a65", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "202c9225-2d8e-4f22-9e7c-0a8d45903110", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f2625e-3321-4533-b11d-0245fbbe4867", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0abc10c6-a9ad-4907-8664-1fafb20f8c64", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ec5d236-9d42-4082-8595-5fd480b53628", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce2f768b-4ccf-4167-a90e-42940243710c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1352b9-676e-4788-89e0-6e6aaf9cf315", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94773d01-569c-47bb-abc4-442e9a1e28ee", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "fa8f7466-988b-4db4-91f2-39cc3fb8d1d6", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efdc2e60-cd62-4f00-9177-ad65bb9e833d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aadc7b57-1405-46af-b66e-dea1d6ddfc1c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19bc7bee-96ae-4949-b547-6bf2b03fe428", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dac9bbf-c54e-4c21-ac80-4c36c24412b3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb78aeb-6e91-46b0-856f-43288efd08e7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53f9f40-9271-4f65-a706-e69a3f0e5c1c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77371719-703a-4f7c-ae78-54cc0966220f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81f075e0-722b-417f-bed7-b1a1d94e0bbc", "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": "d6611fbd-bfb5-4634-a1f5-5a13acb83eab", "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": "ae0215dd-b7f4-4a0b-b3c4-ebf418915991", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdaaf79e-ede4-490c-8382-a0ec69370b18", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "087c90d8-90a2-4598-b873-cc6700376824", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2575cda0-f13b-472f-99f4-6057025a2979", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77f2f6b3-989a-4ef8-bb35-f476a1d37be4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "262fc2d3-536c-4f54-9619-36e9368b531d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4004bf4c-adb3-4854-9271-13d61248ab57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c075d9ff-21c9-4af7-b3f5-72f3f845f338", "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": [], "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": "8f314b5a-c99d-490f-8217-9c30fac6d03d", "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": "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": "204c12b6-896d-4124-9841-e05bce1515e6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d153ca-a541-4a46-9271-10cb05722bf4", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d6e95b3-e795-4f3f-817c-ad8c100fc473", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "924d7c85-cf33-4d5a-8a72-c1fdd5b19547", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87184911-e3e6-4373-bdc5-c9edce348eac", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "441fe674-6f02-41e5-a846-8c30c26b196a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e98228a5-bf91-43da-bf2c-a586ba76fc66", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12ac5e44-db5c-4449-9239-27aae1655b10", "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": "023dae98-dfd0-4fc8-a6e4-80757f81b3b3", "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": "ae9aea2e-8fa9-4207-9a1c-e9f028537124", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acb55c87-64a7-42f5-ad2b-92d2eb2c53a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ac6b06-8044-45c6-ada5-759240ac8e10", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31012b6f-7015-4883-8b84-7f72467b46e8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbdec04-dad6-4e42-8be3-f930062c67a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc558fe-419d-406d-9258-2406bbf037ce", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3966b861-bd99-4348-af01-4899227d9e64", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "603b6cff-2b86-4f63-821b-0302b6268945", "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": [], "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": "37e9d049-6807-461f-9366-e37c4572df35", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5129b275-5eec-43a0-9dd9-09f6e0f441a2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d43c8ec-32d0-43d6-b835-b7e56b5885ca", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe925cb-0673-46ce-8ff1-0e918ed77dab", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "179a289e-20ab-42ca-97ae-e21f49c85989", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4fee0d-77ff-4e7e-bef1-118621125547", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "676bf670-735e-441a-a2d5-1c7924867d2b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7251f6-8478-4746-aed8-dd2b7e2732e8", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bbdee2f-d020-46db-bc95-77ef06b0e5b1", "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": "26f75527-7061-40f7-8226-41ec5b2f30ce", "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": "e3e5bd0e-a0d6-4c11-85cd-13b1bb98a4ad", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "980aae4e-0a4d-4e38-9e4c-609ac6914e06", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f48790b-0153-415f-b062-463e09d29b95", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2509580c-996c-428b-9fcc-3c590d4c98fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbc9ed2-206c-4f20-baf2-0fd6fc6aa402", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "942c3f00-8172-4372-b7a5-517d296232f5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970c31a4-e6ac-44dc-871a-ccdc6d84da43", "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\": 1508,\n \"message\": \"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": "ed72f298-dc5f-42b2-8373-af2a513b3a8e", "name": "Tags", "description": { "content": "Tags endpoints.", "type": "text/plain" }, "item": [ { "id": "e5961990-8cf6-4163-9f09-b79b252fa138", "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": "b9676916-49de-4c5a-9bbe-e8b372bd3952", "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": "83978a47-5f32-4d5f-aabb-2d2c2c80fcc0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c085cb-bf02-4867-8b0d-cf16945d795c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f71836a-c888-4c57-96bc-89bbfad0e72f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e46f7625-c977-4d29-a217-d64ba7ddd1f7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f021726f-025c-4f7f-80e9-81042b43bd4c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5310e81-4cbf-44cf-b271-01177502e30d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37fd3a71-1627-4c7a-9543-75e4af83100a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6913b86c-ae46-40c3-a3cd-d157258e9524", "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": "116fa51c-3746-4570-b79b-8e11598c3559", "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": "282d82c7-f4f2-4452-87a8-d6133e602ff9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dfac58a-2d50-4197-8ab1-954e70aaf023", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27827886-8858-419f-b194-5e41f6235b4f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58a882f1-3572-4e5f-812b-476986f16487", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d24204b-7a51-4472-a5e3-4253b853c2a7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "752379f8-e554-4c02-bc15-d90af6a2c1cd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e233ec8e-f7bb-4c07-9a5d-368e6d666219", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c078468-92db-46c4-b085-aaf8a8f1e5b6", "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": "1bd12eb8-ab53-40a4-9c1f-6783b69c6b6e", "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": "59c83d28-e363-412a-b3aa-ef24acc216b2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffeeb533-633e-4f94-aabd-86f7218ef428", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7372b9cd-b44a-40d7-8ab5-62ae8a3c2834", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f98b1061-57a5-4555-8ada-9d744105643a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e05cb91-f40d-4ae3-885b-0b2c934305eb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0cffb12-bf13-437d-940b-eb4efae2cad6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e711050-0fee-4044-a45c-ba5200cf3a29", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35890185-8af4-49c9-b39c-0ca9ff13b41b", "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": "96e43d53-d5ef-47f0-9a30-8270bdbba8f5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc860a7e-8169-4258-9ae4-050e2cb829a0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37117359-1242-4f91-8f1d-e065dcfbd15f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d550a4-881e-4764-ac3f-9347af562d3b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6add7def-449f-4099-9b90-e5e4f7c8e976", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "990dac01-f9bf-4dc7-ab00-affb27bb6da4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f83abc8a-afc5-4c7c-9d64-2d4ac6e8d213", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1ed4f2-df23-4541-9b16-c63185eab686", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d67e1e0f-4263-4620-a246-4ca12d66d193", "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": "202e3a96-cea7-4716-8f97-a8fd1bca7f41", "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": "7d1d0f59-0ea8-4830-b380-5d6477fd2dcd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038bf2ad-c776-48f6-ac93-9b8ef242076e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "203ac8ba-8161-45db-bc70-21a7c0933858", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12bfbe5e-84dd-4e55-b107-3d4e3eda9060", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfc70ee8-913b-4f8c-a2ae-548a9911f975", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa1e457-d52d-44bd-870d-7535a78c7b57", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a19305af-ba40-416e-9ff0-429212498145", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7103d2b0-a0cc-4af3-9620-25ef48feceab", "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": "10029d20-a7ea-4b04-a57d-2dcdec21850d", "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": "cf44a33f-a7a7-426d-9521-43834a76fbb4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b484c41-3fcb-4d3c-a80a-0ae74105fa99", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb9588a8-14b2-4a7d-bdbc-e7c6ad0d7c2f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f1227a-d396-4051-b2f1-0b1cb45bdd9c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167516b7-b21e-4bf5-99f7-2aff63fbf6ea", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "025198d8-8342-4722-9e94-5c8f0d4f80f1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ec63b17-828b-4273-ba52-3634b0d9fff5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df35dbc0-0cb6-49bb-beb0-1aea8d5cd288", "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": "488f8211-efce-4d6b-b0e9-4986685bed98", "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": "95487307-e4bd-4efd-a866-13050d82fdc5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef941f77-6509-4c33-be09-271b0169979b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "551394ff-fc1d-4e3d-8596-754bdff3fbdd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d1bd86e-779b-41ba-96fc-f52a1563573a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "364f408a-bc50-4339-9e10-c1a19647089f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a452d66-5b39-45ca-ad46-260bd9c08c20", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c80d676-ce6d-42b5-b4c5-a06c096b1671", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf59fd70-0539-4f91-85d1-d8f7cfbf68e7", "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": "9bf22a99-e17a-48a6-a551-2bd771172242", "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": "366c9bb5-1c67-4a29-8f09-cedc6fa3c4b7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ca1b77-c859-4322-b196-8dc48e07865d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76a553a-dc2a-4fd4-a589-615bf9250ebb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b86b556-6355-44e2-bd5d-455720ecd1e9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc75b4f8-404b-4e5a-bf03-1aa8a4c54d64", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4792b2ba-df4a-4559-bf48-7bf7527b9d3d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34f0e1b-0171-4db5-8db1-3c93294aae21", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "027b9455-a493-46a5-b38c-82920b1029eb", "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": [], "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": "ff0545d9-5c88-43f8-bb24-7b3954e8d026", "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": "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": "840b535b-e15c-4887-bb3c-9b1da17f738e", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46facc6a-b101-4924-ba85-f7328bed3dbe", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb8e5aa-9e4f-4a98-acb1-656c08e3fd6a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11adaef1-f55f-415d-877b-b81e1321091a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c732400-6325-4d18-aec5-e82224c6c9cb", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92699c89-185e-4bea-a284-a665b2a8f820", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a8d707-64d4-4ab2-88df-d3c4c9e2b51b", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89246ba9-d179-4633-8a05-6f712043c542", "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": "3ce0cf22-85eb-4cb4-970b-a7ddfa5b7d07", "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": "c224324d-35e6-43b3-848d-3aa899b8a859", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85d07ab-6f79-4597-9e0c-b16cc9b0a56b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ffbde22-9080-4266-a963-e4e651e0097e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a438d8a-df74-42d2-8f1a-8c1c4bbb278e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f6d0a71-b96b-4b1a-8a18-48b5126bd8b0", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4ef3348-4e47-45d1-9b01-84015023baa6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52ce1ee4-163d-4fe5-aae9-de56026c228a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "120d2c20-2b19-4ba0-9539-d393d8e83a4f", "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": "a130512f-1cdd-4357-a6ba-dc13d277bba1", "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": "47d0cde6-553c-4c00-8016-337ba053bc9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d29818-73e2-4bb6-8dcd-eca552e5c777", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96f8cd21-9884-4072-8bd5-bbaa46e7afe7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baac0245-350d-4992-a8b6-01249ffef44c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af79227-4f17-4516-b35b-e29c033a5963", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90111f8c-e31f-43be-8069-aa65dfd96d6c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f73b492a-6577-430b-8bf3-403e01391e2f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd9c807e-622e-4a6d-bd6c-6c3db8eec542", "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": [], "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": "44ac189b-a8e9-482c-819b-8f9886637d82", "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": "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": "0bbcae15-61f3-4bae-988a-4ab2ecdbe4f6", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814b06dc-623b-4dc7-9cd2-5a909037e9c8", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffea6231-8cb8-46f4-aa09-2a0d6c099bfe", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a898ca64-1395-4a66-8f82-20142243acc1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f33a502-7255-430a-b9ed-6bc00b605ed0", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59dd0c0e-d9f5-45c8-aa42-dce36c024c09", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82625d1f-d953-4760-bfe4-3f680d5857e2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08767426-33af-4a26-9c81-fd8079e055cd", "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": "aeb959f1-462a-41e8-b2f2-76d7176beded", "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": "95548956-f304-42eb-a8ac-2b69f7c15cb5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e5d5268-c6d2-46e0-95b3-d478a1db838c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66772925-fb31-48d0-bcce-e87a8c09faee", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdcdb093-0228-4cdc-bb04-51c9785b1ab1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ab3ec84-a007-4b1c-b4e1-8558b13988c9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393a7f06-5714-40cd-a28b-49fc39c44272", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a08f9e2-b512-41e0-84f0-ccf214a21752", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e7192e9-6337-48a5-b905-3fcd1b847aa7", "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": "50734e3e-7dae-43e1-9023-7f1e9864a94c", "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": "40606394-4479-4824-92eb-ec80d99311e4", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f1894e-2599-46ab-b9a6-e40868f6b136", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4ed8c84-5f1f-4d2d-ae59-a0cbc54558a6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d9c774c-3cb3-4ebe-81b7-df57b75b10d9", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb732481-6caa-4140-95aa-70ca3ffe2f42", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f3dd106-969a-41d0-a31d-4313a3f45c71", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef571728-1892-4bbf-b4f8-5f2d4ee71201", "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\": 1508,\n \"message\": \"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": "5186d03b-591b-42bf-ba1e-d2273308f181", "name": "Task", "description": { "content": "Task endpoints.", "type": "text/plain" }, "item": [ { "id": "d443b4b2-16b3-4e2e-ac1e-2a87c996498f", "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) `task_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\nword, in the encoded form `%3D%3D`. For 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=task_ids%3D%3D1,2,3`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`\n- `filter=until_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- `id`\n- `create_time`\n- `due_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": "85d1a05f-807f-464f-927d-b1df810e0e55", "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": "fd9ab1b1-d4d8-4c96-a801-283038e0cbdd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6e29b13-8a01-4d32-b3c5-64c0e8581629", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca2fca75-4217-49ba-a63d-8e6588e7744f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3bfeba5-f785-4fbb-b26f-51f320559580", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "746bdb0b-2f31-417f-badc-21cea2701977", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ac8703-301b-438f-a680-e67448aaa777", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "effe1cfd-2e24-48fd-97d0-fefbe478b225", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a2a588a-7d96-43ff-a5a1-b2610bae4b8b", "name": "Create a Task", "request": { "name": "Create a Task", "description": { "content": "Creates a new task as the authenticated user.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 120,\n \"contact_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "246ed06f-6138-47cc-a94a-e976ec2e4e02", "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 \"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\": 5,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e79dda6-f780-412b-8090-6736bc8b625d", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c49cfea0-af16-4a33-a646-3797a9970b06", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9479306c-85a2-48ff-a501-a71ac54595b8", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb0925a9-62b4-48ba-9b68-c3821b149b5e", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a1a0d4-c2ab-4d2d-8ba2-6009b62a974d", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "179dbea5-06a2-4e61-a083-b021902d19dc", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5704f0e3-6607-4028-a004-e9054926600e", "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 \"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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9f3e035-1674-44f2-bc21-78996a07576c", "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\": \"USER\",\n \"label\": \"string\",\n \"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": "30f07a48-2b6b-4824-8238-df9ddeeea068", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_field\": {\n \"id\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n },\n \"record_type\": {\n \"value\": \"\"\n },\n \"field_type\": {\n \"value\": \"\"\n },\n \"default_value\": {\n \"value\": \"\"\n },\n \"group_id\": {\n \"value\": \"\"\n },\n \"field_name\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6a7541-52a2-49c6-9762-41d68561fd09", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a4cf72-628b-4b23-b7c5-e5bd064a454d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7d03fb3-128e-4971-bbbb-47b01bca90f2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "630a3a59-311f-4a0d-ae0d-f39ec3647f48", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31baa6a6-7a31-4fbe-ac1f-9e346a6b0a9d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53ca46e-7504-4c3f-b894-b9a6b864ddb9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c299fd9b-2eb2-4435-9cf6-cfdf136f9c86", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"MONTH\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4982984c-8b90-41b8-80dc-f4da6418cebb", "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": "da7104eb-78a7-4885-a570-34cd3af7c510", "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\": 5,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bb97130-ddc0-4995-8f5c-9164ac63e225", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbdecdb9-db14-456c-82c6-dfc03b7497b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "307433f0-745a-408f-a5fe-83321b926a5c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e7fdf28-c60d-4a82-9dd4-c04a066360fb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27f5d555-293f-4a64-bd57-33abdac026f6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "404fd7fc-382b-41df-8bd1-3603de711c6d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21251403-4447-42dc-bcb2-c40caae0f1e2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e641647-1bf1-4bcf-bfcb-602225e26319", "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": "379f2a13-52f2-46a1-9196-5b1e5e289487", "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": "54b1f286-fa15-4551-b0bb-a2d8ef3449a7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24318e1b-7c3d-46b6-8936-bbf8f4c183d8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f489b44a-d972-40d1-b2bf-24c0419f4c69", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13aed88-32a5-490d-a055-20482d9cd1ab", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f8a540-59ed-404b-9139-ae36b1681f45", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c45ba9-a8b5-4a7b-98ff-a445ddb25edd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f8a6818-9339-440d-a93f-9bc017389f52", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56bf39c7-13a4-4fed-8036-eb8fa30a34c1", "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": "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\": 5,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "928e4f11-25b3-48a8-972a-e5e8cf4cb145", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 5,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7fd00e5-d0d5-4548-951c-abb167cae961", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3dc67ec-b706-41e2-a1c7-90edef25af7e", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dfef965-3299-47d0-b9c6-e0636e01c556", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d33a5c6-d00c-4d54-b86d-c8e799cd6637", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8f3638f-bbd8-42e5-a817-2c7edabfd1ba", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29fae27a-06cd-4fae-8040-afb01b415e8f", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cc7ecd9-29a7-4053-a9f8-680a1f7bfc7d", "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": "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\": 240,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "759d1398-0a16-45d0-b7e9-b4e7e7d280e0", "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": "1b86cc0c-110d-4007-aee1-402a23a4830b", "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": "8f1fa804-828f-46d0-94a0-7e95ddf68f33", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c90546-2d41-4d87-b382-ab9277948073", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134a8eb8-8162-4d83-ba74-b1ed56073935", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "798896c7-dfea-4f00-bdd0-6cf0a9364127", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45e1d641-2b00-4215-9ba4-c798594956a1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39fe1c43-9057-4381-b383-58ab13fe731a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f951842-1df5-403e-b071-6361361b51ae", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4054f82d-00d5-4238-bf0a-d8f010648a70", "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": [], "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": "67c7cf14-3e7c-4b4a-bb47-07eafb05646f", "name": "OK", "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": "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\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"REFERRAL_PARTNER\",\n \"field_type\": \"YES_NO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"field_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8039a93-0f49-4e32-bb45-4c0a9f1652b2", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad485260-ba70-42cd-8afe-45a5656a6d4d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bda111f9-40a1-4add-b9b9-b147aec0063a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea9c703f-1b93-414e-9729-590082327a0f", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfeb1712-80a5-485f-a221-38c4b2658d5f", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6103f576-e397-4046-93b2-20819aa8f15a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73b95820-cc73-4a56-a014-481142ee8237", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9f76dc0-b17e-49a3-9bc0-fc3262eb0215", "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": "03d38cf6-869d-4204-8599-8e9c8bcc53f9", "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": "a8d80ce4-67d1-440b-987e-23b3a9896144", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbc07b5e-b68f-4f67-930e-2c890b26fc03", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e34b8f0-3420-4135-aa56-b221394abc87", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "661ef13f-a926-4c31-aa70-44ffdc08a9e7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8a05481-d54c-4096-8bac-ae17581eb2c2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "617e24b4-1287-442d-9414-1acd5ead41fe", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c43d5d5-f298-47b8-b701-4493364abb03", "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\": 1508,\n \"message\": \"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": "5acab318-90ea-4b70-9294-942670e8dd57", "name": "User Groups", "description": { "content": "User Groups endpoints.", "type": "text/plain" }, "item": [ { "id": "4cf53913-1608-4750-a9c8-cb4d1faceeb5", "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": "fdae620f-4a5d-4dad-87c2-6e625cdae94e", "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": "31e611f9-89a9-403a-ad2d-c12110af79d1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d09e882-d10d-4cc2-968e-25b096c5dcc8", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e639b4-cb3e-4d1e-afc6-979177866a81", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "187cd132-275a-401c-a8be-9f8bc6607d70", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e2dcb45-09de-4169-b51d-d318647d9562", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3887465a-1fc9-4673-a098-aea99d1aab6d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a78c00-a7fb-4f4a-b600-8eb89f3aae5c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30bd2176-5533-4b99-8987-1811f48bf9e4", "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": "44e73fa5-f7a9-413f-b424-8eac6b609a61", "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": "8fe322ac-cf80-4ba1-8d1e-6294df43ad0c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11a24f43-5f85-4bfc-9fc0-7ba1ff7d365d", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0ac5e68-0ca2-4071-baa9-e88c2deb29dd", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7c31e3-5361-4a25-9198-b88076954cf2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48134612-ef26-4788-aacc-bad65f9ced47", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2484172-f1a8-4302-b2dd-cecb8dc369ab", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3455b84c-e5c8-46ab-b334-fe812cf8c80f", "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\": 1508,\n \"message\": \"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": "86a4c6e2-3996-4a08-a3ec-353dadbe34d0", "name": "Users", "description": { "content": "Users endpoints.", "type": "text/plain" }, "item": [ { "id": "3fb836f9-6493-460e-8c14-6709ae11f575", "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": "0196d60c-4ae3-412d-a173-00061bef656f", "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 \"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": "ee3285aa-a853-47a0-b4dd-811af1730a91", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd155485-6b85-4e41-ba60-e25959453328", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ce94b7-2700-45ee-a5ce-a97a66c58516", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d27e4873-9dc3-4883-b0fe-42fb83a2741a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d348f89-d919-44c3-bcd4-09f4012cf787", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f69abd5-559e-41e7-ad2d-32cd7c67b59b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29cebb29-9a37-4174-a425-e40c089b0b73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b8eae85-52d8-444d-b81f-a77b504ea272", "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": [], "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": "4ead87f1-117e-426d-8952-6346f79d19c5", "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": "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 \"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": "2b943e17-c86a-4383-88ce-297f38936ad1", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e6bafaa-c84d-47ee-8bd5-8362ac70f987", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e750b459-4a93-49b6-a6c8-ac885ac621af", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc070a4-e999-4781-90a4-42f17ab45f37", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7316f2f0-d50c-4715-8e6d-2c5c7167a07d", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8169aeef-18f4-4eab-bfed-907f1704e383", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69696247-f1c3-4557-a3b2-b7ee8347363a", "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": "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae3a5df8-dfc5-485f-962c-de73091243a0", "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\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": "add0191e-3053-4fcb-a863-97f4ab267649", "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": "48ff0e2a-9ddd-4a24-996e-c94c842a983a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44140476-8dd3-4301-b40b-daac630250fc", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a8297bb-0b29-4590-b715-fad596b44709", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b3285e2-02a0-4c12-b1ca-bee8f260e26f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2d71f3-620e-4c07-8ded-86429d70e1b6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9e8f246-d2fc-4169-af80-639947e89a27", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db4acf8-c350-41a6-8ec8-5ae7b5527156", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "535e0361-bb63-4046-a0b1-bfd2401d9b92", "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": "71cbdc2a-89dc-45eb-9621-51268414b2d5", "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": "24ac68d4-2c6c-4bc8-930b-395dfa0374d3", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db91e2e-899a-455a-a622-504a2886fa52", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c429d696-87de-498f-bb99-e6abd8dd7b73", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f6dd44-6875-4674-ab8e-025b4add9f39", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1c51f0-6e22-468a-8c75-1e5fc19206aa", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "740e0f7b-478b-42c6-b2d3-9641ef71292c", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d228a20-ea2b-4ce2-823c-daa99e8cdaa1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5fa4a59-f54a-4c3c-a111-aa1161b791be", "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": "781e5c51-7d5a-43f7-abb0-53b1146d3daf", "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": "0254a7b8-984c-4df6-9f2e-519c53d03ea1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1673b38b-28cc-4737-b4cf-3e96d98c14ec", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10df0fa4-b284-41f1-a53e-8d62be31b8a5", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105caec9-2cad-4bb6-8b46-d3edfe70ce05", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29ec4d2e-29fd-4cb8-a6e5-4ed7bc857544", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2111ffea-e984-4e57-b9a8-c3fd3950b117", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f575f837-e813-400e-955f-1f4272b6d4b2", "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\": 1508,\n \"message\": \"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": "9f0436e1-90a5-4d21-bb9b-1e90406e8d74", "name": "Webforms", "description": { "content": "Webforms endpoints.", "type": "text/plain" }, "item": [ { "id": "d52fb0b6-77ef-42c3-884b-6c49bc1637f9", "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": "b1486d70-6773-466d-895d-e7f0a11c195c", "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": "1d7108bc-e0c8-429a-b040-9ceb2823908e", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061ea266-d6af-4c7e-9f97-494a9dfe7bb1", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b7588a-cda1-46e7-b982-1f9d3d61f7ec", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52e6455e-8cab-479d-b456-8419a2e78585", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d48e224a-6090-447f-9444-facf30bdb6be", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f670a1e-79bd-4aad-9390-6656abbbdd2b", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0da746d9-863c-4c48-aec9-637340241ee6", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88499833-2696-4f0e-9dc3-382b175c8bb3", "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": "088ece93-b704-435e-9839-02fd11e449f4", "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": "d4ed1580-3884-4333-8d74-2534f3446dcb", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8496225d-0437-45e0-8810-fe6c07158c9f", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e40fb71-452f-4d4e-a79b-7d2bac087d26", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c2c8114-4660-4afa-8ef1-a631ebf08bf2", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1cb0d16-661b-4c14-b6da-86453d5237c7", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99b0e2c3-4586-4e8c-817f-e631ec1e3a42", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "703f6147-ce88-4a8e-b396-197a76e03f2a", "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\": 1508,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-intg.infusiontest.com/crm", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "webform_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "subscription_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the report (Saved Search) to execute", "type": "text/plain" }, "type": "any", "value": "string", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) product_id", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "category_id" }, { "disabled": false, "description": { "content": "(Required) ID of the payment method to be deactivated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "payment_method_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_item_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "file_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "sequence_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "commission_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "affiliate_id" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "https://api-intg.infusiontest.com/token" }, { "key": "authUrl", "value": "https://accounts-intg.infusiontest.com/app/oauth/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "298bc4ae-86f7-4c80-b411-5d123f3fc489", "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" } } }