{ "mappings": [ { "id": "1211c905-93ae-4aa1-a220-5b0994166727", "name": "Get account details - default", "request": { "urlPathTemplate": "/account", "method": "GET" }, "response": { "status": 200, "body": "{\n \"planVerticals\": [\n {\n \"planCategory\": \"Marketing\",\n \"planType\": \"free\",\n \"name\": \"Free\",\n \"status\": \"active\",\n \"startDate\": \"1751234567\",\n \"endDate\": \"1753826567\",\n \"users\": {\n \"purchasedSeats\": \"1\",\n \"usedSeats\": \"1\"\n },\n \"credits\": \"250\"\n },\n {\n \"planCategory\": \"Chat\",\n \"planType\": \"free\",\n \"name\": \"Free\",\n \"status\": \"active\",\n \"startDate\": \"1735678901\",\n \"endDate\": \"1767214901\",\n \"users\": {\n \"purchasedSeats\": \"1\",\n \"usedSeats\": \"1\"\n },\n \"credits\": \"250\"\n },\n {\n \"planCategory\": \"CRM\",\n \"planType\": \"free\",\n \"name\": \"Free\",\n \"status\": \"active\",\n \"startDate\": \"1735678900\",\n \"endDate\": \"1767214900\",\n \"users\": {\n \"purchasedSeats\": \"1\",\n \"usedSeats\": \"1\"\n },\n \"credits\": \"250\"\n }\n ],\n \"organization_id\": \"5fa2b8c123456789abcdef01\",\n \"user_id\": 1234567,\n \"enterprise\": false,\n \"companyName\": \"Acme Marketing Corp\",\n \"email\": \"michael.davis@example.com\",\n \"firstName\": \"Michael\",\n \"lastName\": \"Davis\",\n \"address\": {\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"street\": \"456 Business Ave\",\n \"zipCode\": \"10001\"\n },\n \"dateTimePreferences\": {\n \"timezone\": \"America/New_York\",\n \"timeFormat\": \"12\",\n \"dateFormat\": \"mm-dd-yyyy\"\n },\n \"marketingAutomation\": {\n \"enabled\": true,\n \"key\": \"ma8k2x9v4h7p3d6f1c5e8b2a\"\n },\n \"plan\": [\n {\n \"credits\": 250,\n \"creditsType\": \"sendLimit\",\n \"endDate\": \"1753826567\",\n \"startDate\": \"1751234567\",\n \"type\": \"free\"\n },\n {\n \"credits\": 15,\n \"creditsType\": \"sendLimit\",\n \"endDate\": \"1753826567\",\n \"startDate\": \"1751234567\",\n \"type\": \"sms\"\n }\n ],\n \"relay\": {\n \"data\": {\n \"port\": 587,\n \"relay\": \"smtp-relay.brevo.com\",\n \"userName\": \"michael.davis@example.com\"\n },\n \"enabled\": true\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1211c905-93ae-4aa1-a220-5b0994166727", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "8875a0d0-f755-470c-bb61-f8ad06810a28", "name": "getAccountActivity - default", "request": { "urlPathTemplate": "/organization/activities", "method": "GET" }, "response": { "status": 200, "body": "{\n \"logs\": [\n {\n \"action\": \"login-success\",\n \"date\": \"2023-03-16T16:49:23+05:30\",\n \"user_agent\": \"Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us)\",\n \"user_email\": \"test@mycompany.com\",\n \"user_ip\": \"192.158.1.34\"\n },\n {\n \"action\": \"update-profile\",\n \"date\": \"2023-03-15T16:49:23+05:30\",\n \"user_agent\": \"Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us)\",\n \"user_email\": \"test@myexample.com\",\n \"user_ip\": \"192.158.1.38\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8875a0d0-f755-470c-bb61-f8ad06810a28", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "22e8ec1f-e4ba-4f4b-996b-17fb7412b82b", "name": "Create a new group of sub-accounts - default", "request": { "urlPathTemplate": "/corporate/group", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"659xxxxxxxxxxxxxxxx6ef9c8\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "22e8ec1f-e4ba-4f4b-996b-17fb7412b82b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "553c0be2-9f70-4b5f-867b-1d2543c96f46", "name": "Delete sub-account from group - default", "request": { "urlPathTemplate": "/corporate/group/unlink/{groupId}/subAccounts", "method": "PUT", "pathParameters": { "groupId": { "equalTo": "groupId" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "553c0be2-9f70-4b5f-867b-1d2543c96f46", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "569cac67-bd04-4628-af18-b29f58c3426a", "name": "GET a group details - default", "request": { "urlPathTemplate": "/corporate/group/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"group\": {\n \"createdAt\": \"2024-02-09T06:14:40+00:00\",\n \"groupName\": \"My group\",\n \"id\": \"5f926dba72a405440a4efc97\"\n },\n \"sub-accounts\": [\n {\n \"companyName\": \"My sub organization\",\n \"createdAt\": \"2024-02-09T06:14:40+00:00\",\n \"id\": 7866556\n },\n {\n \"companyName\": \"Your sub organization\",\n \"createdAt\": \"2024-01-05T03:11:40+00:00\",\n \"id\": 6563051\n }\n ],\n \"users\": [\n {\n \"email\": \"my-user@my-org.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n {\n \"email\": \"your-user@your-org.com\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "569cac67-bd04-4628-af18-b29f58c3426a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "15046c07-f5ad-4826-99a4-368a6abcc9d5", "name": "Update a group of sub-accounts - default", "request": { "urlPathTemplate": "/corporate/group/{id}", "method": "PUT", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "15046c07-f5ad-4826-99a4-368a6abcc9d5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "204960c9-0571-4a3d-a030-f9779c6aea08", "name": "Delete a group - default", "request": { "urlPathTemplate": "/corporate/group/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "204960c9-0571-4a3d-a030-f9779c6aea08", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d15212a9-7d53-42ef-996e-cbae118ba999", "name": "Get the list of groups - default", "request": { "urlPathTemplate": "/corporate/groups", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"groupName\": \"My group 1\",\n \"id\": \"d3b142c709d6ed67ef1cd903\"\n },\n {\n \"groupName\": \"My group 2\",\n \"id\": \"a5b192a709d6ed67ef8fd922\"\n },\n {\n \"groupName\": \"My group 3\",\n \"id\": \"bbb142c709d6ed67ef1cd910\"\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "d15212a9-7d53-42ef-996e-cbae118ba999", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "431c56cb-581f-459e-a434-b2378dfbb177", "name": "Get the list of all admin users - default", "request": { "urlPathTemplate": "/corporate/invited/users", "method": "GET" }, "response": { "status": 200, "body": "{\n \"users\": [\n {\n \"email\": \"master-user2@company.com\",\n \"feature_access\": {\n \"analytics\": [\n \"download_data\",\n \"create_alerts\",\n \"my_looks\",\n \"explore_create\"\n ],\n \"api_keys\": [\n \"all\"\n ],\n \"apps_management\": [\n \"none\"\n ],\n \"create_sub_organizations\": [\n \"all\"\n ],\n \"manage_sub_organizations\": [\n \"all\"\n ],\n \"my_plan\": [\n \"all\",\n \"all\"\n ],\n \"sub_organization_groups\": [\n \"create\",\n \"edit_delete\"\n ],\n \"user_management\": [\n \"none\"\n ]\n },\n \"groups\": {\n \"id\": \"a5c4f22c08d9ed37ef1ca342\",\n \"name\": \"My group\"\n },\n \"is_owner\": \"is_owner\",\n \"status\": \"active\"\n },\n {\n \"email\": \"master-user3@company.com\",\n \"feature_access\": {\n \"analytics\": [\n \"create_alerts\",\n \"my_looks\"\n ],\n \"api_keys\": [\n \"none\"\n ],\n \"apps_management\": [\n \"all\"\n ],\n \"create_sub_organizations\": [\n \"all\"\n ],\n \"manage_sub_organizations\": [\n \"all\"\n ],\n \"my_plan\": [\n \"none\",\n \"none\"\n ],\n \"sub_organization_groups\": [\n \"edit_delete\"\n ],\n \"user_management\": [\n \"all\"\n ]\n },\n \"groups\": {\n \"id\": \"a5c4f22c08d9ed37ef1ca342\",\n \"name\": \"My group\"\n },\n \"is_owner\": \"is_owner\",\n \"status\": \"active\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "431c56cb-581f-459e-a434-b2378dfbb177", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "47be7c71-5117-47ca-8146-e166b37fbd89", "name": "List of all IPs - default", "request": { "urlPathTemplate": "/corporate/ip", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"domain\": \"example.com\",\n \"ip\": \"192.168.1.1\",\n \"transactional\": true\n },\n {\n \"domain\": \"example.com\",\n \"ip\": \"192.168.1.2\",\n \"transactional\": false\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "47be7c71-5117-47ca-8146-e166b37fbd89", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "c8f6e272-2e8b-4912-b109-ef644f37c748", "name": "Get the details of requested master account - default", "request": { "urlPathTemplate": "/corporate/masterAccount", "method": "GET" }, "response": { "status": 200, "body": "{\n \"billingInfo\": {\n \"address\": {\n \"countryCode\": \"IN\",\n \"locality\": \"Pandav Nagar, New Delhi\",\n \"postalCode\": \"560048\",\n \"stateCode\": \"UP\",\n \"streetAddress\": \"C-92\"\n },\n \"companyName\": \"Corp Sample 1-1\",\n \"email\": \"sample@example.com\",\n \"name\": {\n \"familyName\": \"Pandit\",\n \"givenName\": \"Uday\"\n }\n },\n \"companyName\": \"Corp Sample 1-1\",\n \"currencyCode\": \"INR\",\n \"email\": \"sample@example.com\",\n \"id\": 1003286,\n \"planInfo\": {\n \"currencyCode\": \"INR\",\n \"features\": [\n {\n \"name\": \"MULTI_USER\",\n \"quantity\": 10,\n \"remaining\": 0,\n \"unitValue\": \"unitValue\",\n \"used\": 15\n },\n {\n \"name\": \"ADVANCED_REPORTING\",\n \"quantity\": 12,\n \"remaining\": 11,\n \"unitValue\": \"unitValue\",\n \"used\": 1\n },\n {\n \"name\": \"INBOX\",\n \"quantity\": 10,\n \"remaining\": 0,\n \"unitValue\": \"unitValue\",\n \"used\": 10\n },\n {\n \"name\": \"LANDING_PAGE\",\n \"quantity\": 10,\n \"remaining\": 0,\n \"unitValue\": \"unitValue\",\n \"used\": 11\n },\n {\n \"name\": \"RECURRING_CREDITS\",\n \"quantity\": 500,\n \"remaining\": 499,\n \"unitValue\": \"unitValue\",\n \"used\": 1\n }\n ],\n \"nextBillingAt\": 1637739295,\n \"planPeriod\": \"month\",\n \"price\": 2100,\n \"subAccounts\": 15\n },\n \"timezone\": \"Europe/Paris\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c8f6e272-2e8b-4912-b109-ef644f37c748", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "8fea4e4d-838b-4875-b315-9790bd457518", "name": "Generate SSO token to access admin account - default", "request": { "urlPathTemplate": "/corporate/ssoToken", "method": "POST" }, "response": { "status": 200, "body": "{\n \"token\": \"5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8fea4e4d-838b-4875-b315-9790bd457518", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "45b2935e-aecb-4ad4-8888-9a0e585bcd23", "name": "Get the list of all the sub-accounts of the master account. - default", "request": { "urlPathTemplate": "/corporate/subAccount", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 3,\n \"subAccounts\": [\n {\n \"active\": true,\n \"companyName\": \"Company1\",\n \"createdAt\": 1631523176,\n \"groups\": [\n {\n \"id\": \"5f8f8c3b5f56a02d4433b3a8\",\n \"name\": \"Group 1\"\n },\n {\n \"id\": \"4fbf3c3b1f56a02ac465b1a0\",\n \"name\": \"Group 2\"\n }\n ],\n \"id\": 4043629\n },\n {\n \"active\": true,\n \"companyName\": \"Company2\",\n \"createdAt\": 1629439311,\n \"groups\": [\n {}\n ],\n \"id\": 3984002\n },\n {\n \"active\": true,\n \"companyName\": \"Company3\",\n \"createdAt\": 1614713641,\n \"groups\": [\n {}\n ],\n \"id\": 3524191\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "45b2935e-aecb-4ad4-8888-9a0e585bcd23", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "27e8ff22-470d-462b-a9e2-6cd1c428b361", "name": "Create a new sub-account under a master account. - default", "request": { "urlPathTemplate": "/corporate/subAccount", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 4109344\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "27e8ff22-470d-462b-a9e2-6cd1c428b361", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0b1c8ee5-ea29-4bb0-a233-53d0ff4d86fa", "name": "Associate an IP to sub-accounts - default", "request": { "urlPathTemplate": "/corporate/subAccount/ip/associate", "method": "POST" }, "response": { "status": 201, "body": "{\n \"key\": \"value\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0b1c8ee5-ea29-4bb0-a233-53d0ff4d86fa", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b9524079-a627-4ed4-8f2a-abb0390700aa", "name": "Dissociate an IP to sub-accounts - default", "request": { "urlPathTemplate": "/corporate/subAccount/ip/dissociate", "method": "PUT" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "b9524079-a627-4ed4-8f2a-abb0390700aa", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "69800c09-607d-406d-8817-7c7c51ff5ae1", "name": "Create an API key for a sub-account - default", "request": { "urlPathTemplate": "/corporate/subAccount/key", "method": "POST" }, "response": { "status": 201, "body": "{\n \"key\": \"xkeysib-21881axxxxxcc92e04-mIrexxxx7z\",\n \"status\": \"success\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "69800c09-607d-406d-8817-7c7c51ff5ae1", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c6174a85-f3d7-4550-bc89-0e9814e58cfb", "name": "Generate SSO token to access sub-account - default", "request": { "urlPathTemplate": "/corporate/subAccount/ssoToken", "method": "POST" }, "response": { "status": 200, "body": "{\n \"token\": \"5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c6174a85-f3d7-4550-bc89-0e9814e58cfb", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a2fc395f-9a4c-407e-bcf3-5eb067c54991", "name": "Get sub-account details - default", "request": { "urlPathTemplate": "/corporate/subAccount/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"companyName\": \"API-Sub-26thOct21-4\",\n \"email\": \"uday+1@brevo.com\",\n \"groups\": [\n {\n \"id\": \"5f8f8c3b5f56a02d4433b3a7\",\n \"name\": \"Group 1\"\n },\n {\n \"id\": \"5f8f8c3b5f56a02d4433b3a8\",\n \"name\": \"Group 2\"\n }\n ],\n \"name\": \"Uday Pandit\",\n \"planInfo\": {\n \"credits\": {\n \"emails\": {\n \"quantity\": 2000,\n \"remaining\": 1955\n },\n \"externalFeeds\": {\n \"quantity\": 1,\n \"remaining\": 1\n },\n \"sms\": {\n \"quantity\": 2000,\n \"remaining\": 1955\n },\n \"whatsapp\": {\n \"quantity\": 100,\n \"remaining\": 50\n },\n \"wpSubscribers\": {\n \"quantity\": 2000,\n \"remaining\": 1955\n }\n },\n \"features\": {\n \"inbox\": {\n \"quantity\": 20,\n \"remaining\": 12\n },\n \"landingPage\": {\n \"quantity\": 25,\n \"remaining\": 14\n },\n \"salesUsers\": {\n \"quantity\": 30,\n \"remaining\": 14\n },\n \"users\": {\n \"quantity\": 30,\n \"remaining\": 14\n }\n },\n \"planType\": \"paid\"\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a2fc395f-9a4c-407e-bcf3-5eb067c54991", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "574c16a0-400c-46fe-aea7-88b6b1a0b812", "name": "Delete a sub-account - default", "request": { "urlPathTemplate": "/corporate/subAccount/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "574c16a0-400c-46fe-aea7-88b6b1a0b812", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "769c18cf-d0ef-4284-83e9-bc297f635f71", "name": "Enable/disable sub-account application(s) - default", "request": { "urlPathTemplate": "/corporate/subAccount/{id}/applications/toggle", "method": "PUT", "pathParameters": { "id": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "769c18cf-d0ef-4284-83e9-bc297f635f71", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "85c53397-13d2-43ec-986d-7d85858e7c8e", "name": "Update sub-account plan - default", "request": { "urlPathTemplate": "/corporate/subAccount/{id}/plan", "method": "PUT", "pathParameters": { "id": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "85c53397-13d2-43ec-986d-7d85858e7c8e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "41b0f555-e1b6-4e40-9e6a-17c8bd025f53", "name": "Update sub-accounts plan - default", "request": { "urlPathTemplate": "/corporate/subAccounts/plan", "method": "PUT" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "41b0f555-e1b6-4e40-9e6a-17c8bd025f53", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "2d522f1e-c89e-42da-b070-ffb9ff715ec2", "name": "Send invitation to an admin user - default", "request": { "urlPathTemplate": "/corporate/user/invitation/send", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"659xxxxxxxxxxxxxxxx6ef9c8\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "2d522f1e-c89e-42da-b070-ffb9ff715ec2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d9c935a4-0eec-4d97-9162-0ecfcc38abbb", "name": "Resend / cancel admin user invitation - default", "request": { "urlPathTemplate": "/corporate/user/invitation/{action}/{email}", "method": "PUT", "pathParameters": { "action": { "equalTo": "resend" }, "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "{\n \"message\": \"Invitation resent successfully\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d9c935a4-0eec-4d97-9162-0ecfcc38abbb", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a6f000f1-1ae0-4b47-842f-edac9954cb1d", "name": "Revoke an admin user - default", "request": { "urlPathTemplate": "/corporate/user/revoke/{email}", "method": "DELETE", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a6f000f1-1ae0-4b47-842f-edac9954cb1d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f295c79b-1b65-4112-8b0c-b6ce9d87d44f", "name": "Check admin user permissions - default", "request": { "urlPathTemplate": "/corporate/user/{email}/permissions", "method": "GET", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "{\n \"email\": \"invitedUser@company.com\",\n \"feature_access\": {\n \"analytics\": [\n \"download_data\",\n \"create_alerts\",\n \"my_looks\",\n \"explore_create\"\n ],\n \"api_keys\": [\n \"all\"\n ],\n \"apps_management\": [\n \"all\"\n ],\n \"create_sub_organizations\": [\n \"all\"\n ],\n \"manage_sub_organizations\": [\n \"all\"\n ],\n \"my_plan\": [\n \"all\",\n \"all\"\n ],\n \"sub_organization_groups\": [\n \"create\",\n \"edit_delete\"\n ],\n \"user_management\": [\n \"none\"\n ]\n },\n \"groups\": [\n {\n \"id\": \"6543ab3667ffbb00142e4486\",\n \"name\": \"Support\"\n },\n {\n \"id\": \"174bab366732bbce142e4412\",\n \"name\": \"Technical\"\n }\n ],\n \"status\": \"active\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "f295c79b-1b65-4112-8b0c-b6ce9d87d44f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c29d9b3d-5506-4699-8d63-cb5be4b098e1", "name": "Change admin user permissions - default", "request": { "urlPathTemplate": "/corporate/user/{email}/permissions", "method": "PUT", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "c29d9b3d-5506-4699-8d63-cb5be4b098e1", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "5b756ab9-0c76-4ea0-86e3-2629a91ee517", "name": "Get the list of all your users - default", "request": { "urlPathTemplate": "/organization/invited/users", "method": "GET" }, "response": { "status": 200, "body": "{\n \"users\": [\n {\n \"email\": \"owner@company.com\",\n \"feature_access\": {\n \"conversations\": \"owner\",\n \"crm\": \"owner\",\n \"marketing\": \"owner\"\n },\n \"is_owner\": \"is_owner\",\n \"status\": \"active\"\n },\n {\n \"email\": \"pendingInvitedUser@company.com\",\n \"feature_access\": {\n \"conversations\": \"none\",\n \"crm\": \"full\",\n \"marketing\": \"custom\"\n },\n \"is_owner\": \"is_owner\",\n \"status\": \"pending\"\n },\n {\n \"email\": \"connectedInvitedUser@company.com\",\n \"feature_access\": {\n \"conversations\": \"full\",\n \"crm\": \"none\",\n \"marketing\": \"none\"\n },\n \"is_owner\": \"is_owner\",\n \"status\": \"active\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5b756ab9-0c76-4ea0-86e3-2629a91ee517", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "027416a7-5144-402b-8e13-ff098d91ec53", "name": "Revoke user permission - default", "request": { "urlPathTemplate": "/organization/user/invitation/revoke/{email}", "method": "PUT", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "{\n \"credit_notes\": [\n \"TEST-123\"\n ],\n \"status\": \"OK\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "027416a7-5144-402b-8e13-ff098d91ec53", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3380168e-886f-4ab1-9489-1f453e144d97", "name": "Send invitation to user - default", "request": { "urlPathTemplate": "/organization/user/invitation/send", "method": "POST" }, "response": { "status": 200, "body": "{\n \"invoice_id\": \"invoice_id\",\n \"status\": \"OK\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3380168e-886f-4ab1-9489-1f453e144d97", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fda4aa42-d57d-4f82-8b2b-30f5d0abffa2", "name": "Resend / Cancel invitation - default", "request": { "urlPathTemplate": "/organization/user/invitation/{action}/{email}", "method": "PUT", "pathParameters": { "action": { "equalTo": "resend" }, "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "{\n \"credit_notes\": [\n \"TEST-123\"\n ],\n \"status\": \"OK\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fda4aa42-d57d-4f82-8b2b-30f5d0abffa2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e3763191-26a9-488e-9abf-c8b9ca82c709", "name": "Update permission for a user - default", "request": { "urlPathTemplate": "/organization/user/update/permissions", "method": "POST" }, "response": { "status": 200, "body": "{\n \"credit_notes\": [\n \"TEST-123\"\n ],\n \"invoice_id\": \"invoice_id\",\n \"status\": \"OK\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e3763191-26a9-488e-9abf-c8b9ca82c709", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "8d0fdcb2-801b-46ec-98ff-ef29fa70f35d", "name": "Check user permission - default", "request": { "urlPathTemplate": "/organization/user/{email}/permissions", "method": "GET", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "{\n \"email\": \"invitedUser@company.com\",\n \"privileges\": [\n {\n \"feature\": \"Email campaign\",\n \"permissions\": [\n \"Create / edit / delete\",\n \"Send / schedule / suspend\"\n ]\n },\n {\n \"feature\": \"Templates\",\n \"permissions\": [\n \"Create / edit / delete\",\n \"Activate / deactivate\"\n ]\n },\n {\n \"feature\": \"SMS campaign\",\n \"permissions\": [\n \"Create / edit / delete\",\n \"Send / schedule / suspend\"\n ]\n },\n {\n \"feature\": \"Facebook Ads\",\n \"permissions\": [\n \"Schedule / pause\"\n ]\n },\n {\n \"feature\": \"Landing pages\",\n \"permissions\": [\n \"All\"\n ]\n },\n {\n \"feature\": \"Workflows\",\n \"permissions\": [\n \"Create / edit / delete\",\n \"Activate / deactivate / Pause\"\n ]\n },\n {\n \"feature\": \"Contacts\",\n \"permissions\": [\n \"View\",\n \"Contact forms\"\n ]\n },\n {\n \"feature\": \"SMTP & API\",\n \"permissions\": [\n \"SMTP\",\n \"API Keys\",\n \"Authorized IPs\"\n ]\n },\n {\n \"feature\": \"User management\",\n \"permissions\": [\n \"None\"\n ]\n },\n {\n \"feature\": \"Sales Platform\",\n \"permissions\": [\n \"Create / edit / delete owned deals and tasks\",\n \"Manage deals and tasks from other users\",\n \"Reports\",\n \"Settings\"\n ]\n },\n {\n \"feature\": \"Conversations\",\n \"permissions\": [\n \"None\"\n ]\n },\n {\n \"feature\": \"Senders, Domains & Dedicated IPs\",\n \"permissions\": [\n \"Senders management\",\n \"Domains management\",\n \"Dedicated IPs management\"\n ]\n },\n {\n \"feature\": \"Push\",\n \"permissions\": [\n \"View\",\n \"Create / edit / delete\",\n \"Send\",\n \"Settings\"\n ]\n },\n {\n \"feature\": \"Companies\",\n \"permissions\": [\n \"Create / edit / delete owned companies\",\n \"Manage companies from other users\",\n \"Settings\"\n ]\n }\n ],\n \"status\": \"active\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8d0fdcb2-801b-46ec-98ff-ef29fa70f35d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ec86c15f-d950-46af-8cc4-d9670d01ec3e", "name": "Get background processes - default", "request": { "urlPathTemplate": "/processes", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 198,\n \"processes\": [\n {\n \"id\": 217,\n \"name\": \"IMPORTUSER\",\n \"status\": \"completed\",\n \"export_url\": \"https://s3.eu-west-1.amazonaws.com/api-export.example.com/upload/contacts_export.csv\",\n \"error\": \"Processing timeout exceeded\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"completed_at\": \"2024-01-15T10:35:00Z\"\n },\n {\n \"id\": 213,\n \"name\": \"SEARCH_EXPORT_USERS\",\n \"status\": \"completed\",\n \"export_url\": \"https://s3.eu-west-1.amazonaws.com/api-export.example.com/upload/contacts_export.csv\",\n \"error\": \"Processing timeout exceeded\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"completed_at\": \"2024-01-15T10:35:00Z\"\n },\n {\n \"id\": 212,\n \"name\": \"IMPORTUSER\",\n \"status\": \"queued\",\n \"export_url\": \"https://s3.eu-west-1.amazonaws.com/api-export.example.com/upload/contacts_export.csv\",\n \"error\": \"Processing timeout exceeded\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"completed_at\": \"2024-01-15T10:35:00Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ec86c15f-d950-46af-8cc4-d9670d01ec3e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "5cd8a4a8-5754-4b87-aa94-fc464c24ad7a", "name": "Get process details - default", "request": { "urlPathTemplate": "/processes/{processId}", "method": "GET", "pathParameters": { "processId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"id\": 217,\n \"name\": \"IMPORTUSER\",\n \"status\": \"queued\",\n \"info\": {\n \"import\": {\n \"invalid_emails\": 2,\n \"duplicate_contact_id\": 0,\n \"duplicate_ext_id\": 1,\n \"duplicate_email_id\": 5,\n \"duplicate_phone_id\": 1,\n \"duplicate_whatsapp_id\": 1,\n \"duplicate_landline_number_id\": 1\n },\n \"export\": {\n \"total_records\": 1250,\n \"file_size\": 102400\n }\n },\n \"export_url\": \"https://s3.eu-west-1.amazonaws.com/api-export.example.com/upload/contacts_export.csv\",\n \"error\": \"Processing timeout exceeded after 30 minutes\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"completed_at\": \"2024-01-15T10:32:15Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5cd8a4a8-5754-4b87-aa94-fc464c24ad7a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6ee5e306-247b-485b-9f81-14d36b3a0bda", "name": "Get email senders - default", "request": { "urlPathTemplate": "/senders", "method": "GET" }, "response": { "status": 200, "body": "{\n \"senders\": [\n {\n \"active\": true,\n \"email\": \"support@example.com\",\n \"id\": 1,\n \"ips\": [\n {\n \"domain\": \"example.com\",\n \"ip\": \"203.0.113.100\",\n \"weight\": 50\n }\n ],\n \"name\": \"Support Team\"\n },\n {\n \"active\": false,\n \"email\": \"hello@example.com\",\n \"id\": 3,\n \"ips\": [\n {\n \"domain\": \"example.com\",\n \"ip\": \"203.0.113.100\",\n \"weight\": 50\n }\n ],\n \"name\": \"Customer Service\"\n },\n {\n \"active\": false,\n \"email\": \"marketing@testcompany.com\",\n \"id\": 5,\n \"ips\": [\n {\n \"domain\": \"example.com\",\n \"ip\": \"203.0.113.100\",\n \"weight\": 50\n }\n ],\n \"name\": \"Marketing Team\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6ee5e306-247b-485b-9f81-14d36b3a0bda", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "04b1327d-3b58-45aa-a665-8f8430486eca", "name": "Create email sender - default", "request": { "urlPathTemplate": "/senders", "method": "POST" }, "response": { "status": 201, "body": "{\n \"dkimError\": false,\n \"id\": 15,\n \"spfError\": false\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "04b1327d-3b58-45aa-a665-8f8430486eca", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "17fe3a57-60da-42b1-a435-e4cf134d171e", "name": "getIps - default", "request": { "urlPathTemplate": "/senders/ips", "method": "GET" }, "response": { "status": 200, "body": "{\n \"ips\": [\n {\n \"active\": true,\n \"domain\": \"mailing.enterprise.com\",\n \"id\": 3,\n \"ip\": \"192.168.1.100\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "17fe3a57-60da-42b1-a435-e4cf134d171e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "a0fc45b1-4252-4d1d-a02e-f542df6bf33e", "name": "updateSender - default", "request": { "urlPathTemplate": "/senders/{senderId}", "method": "PUT", "pathParameters": { "senderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a0fc45b1-4252-4d1d-a02e-f542df6bf33e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f691a271-1b98-49eb-b4a0-124162e8a7d5", "name": "deleteSender - default", "request": { "urlPathTemplate": "/senders/{senderId}", "method": "DELETE", "pathParameters": { "senderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "f691a271-1b98-49eb-b4a0-124162e8a7d5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a90c739a-2ce1-4058-a434-60d316495970", "name": "getIpsFromSender - default", "request": { "urlPathTemplate": "/senders/{senderId}/ips", "method": "GET", "pathParameters": { "senderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"ips\": [\n {\n \"domain\": \"mailing.enterprise.com\",\n \"id\": 3,\n \"ip\": \"192.168.1.100\",\n \"weight\": 75\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a90c739a-2ce1-4058-a434-60d316495970", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "868b537b-a700-40e2-bc48-c51dfd0ef8ed", "name": "validateSenderByOTP - default", "request": { "urlPathTemplate": "/senders/{senderId}/validate", "method": "PUT", "pathParameters": { "senderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "868b537b-a700-40e2-bc48-c51dfd0ef8ed", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6efe0f37-1aad-44ee-a626-e10a2df32e40", "name": "getDomains - default", "request": { "urlPathTemplate": "/senders/domains", "method": "GET" }, "response": { "status": 200, "body": "{\n \"domains\": [\n {\n \"id\": \"67e57b40130375f045064c45\",\n \"domain_name\": \"mycompany.com\",\n \"authenticated\": true,\n \"verified\": true,\n \"ip\": \"192.168.1.100\",\n \"provider\": \"Cloudflare\",\n \"creator\": {\n \"id\": \"62e4fce597550d0b0177cb0c\",\n \"email\": \"admin@mycompany.com\",\n \"creationDate\": \"2025-03-27T16:22:24Z\"\n }\n },\n {\n \"id\": \"67f778570dd65f97c70910ed\",\n \"domain_name\": \"newsletter.mycompany.com\",\n \"authenticated\": false,\n \"verified\": true,\n \"provider\": \"GoDaddy\",\n \"creator\": {\n \"id\": \"62e4fce597550d0b0177cb0c\",\n \"email\": \"admin@mycompany.com\",\n \"creationDate\": \"2025-04-10T07:50:47Z\"\n }\n },\n {\n \"id\": \"688cd306d8893504e50ea615\",\n \"domain_name\": \"test.example.com\",\n \"authenticated\": false,\n \"verified\": false,\n \"provider\": \"Other\",\n \"creator\": {\n \"id\": \"62e4fce597550d0b0177cb0c\",\n \"email\": \"admin@mycompany.com\",\n \"creationDate\": \"2025-08-01T14:45:26Z\"\n }\n }\n ],\n \"count\": 3,\n \"current_page\": 1,\n \"total_pages\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6efe0f37-1aad-44ee-a626-e10a2df32e40", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "d932d31f-c588-47e7-8703-1fc734a1dffd", "name": "createDomain - default", "request": { "urlPathTemplate": "/senders/domains", "method": "POST" }, "response": { "status": 200, "body": "{\n \"id\": 5,\n \"domain_name\": \"mycompany.com\",\n \"domain_provider\": \"Cloudflare\",\n \"message\": \"Domain added successfully. To authenticate it, add following DNS records\",\n \"dns_records\": {\n \"brevo_code\": {\n \"host_name\": \"@\",\n \"type\": \"TXT\",\n \"value\": \"brevo-code=abc123def456\",\n \"status\": false\n },\n \"dkim_record\": {\n \"host_name\": \"mail._domainkey\",\n \"type\": \"TXT\",\n \"value\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GN...\",\n \"status\": false\n },\n \"dmarc_record\": {\n \"host_name\": \"_dmarc\",\n \"type\": \"TXT\",\n \"value\": \"v=DMARC1; p=none; rua=mailto:dmarc@mycompany.com\",\n \"status\": false\n }\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d932d31f-c588-47e7-8703-1fc734a1dffd", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "184d536e-335a-4ef0-8445-30b9081f5725", "name": "getDomainConfiguration - default", "request": { "urlPathTemplate": "/senders/domains/{domainName}", "method": "GET", "pathParameters": { "domainName": { "equalTo": "domainName" } } }, "response": { "status": 200, "body": "{\n \"domain\": \"mycompany.com\",\n \"verified\": true,\n \"authenticated\": true,\n \"dns_records\": {\n \"brevo_code\": {\n \"host_name\": \"@\",\n \"type\": \"TXT\",\n \"value\": \"brevo-code=abc123def456\",\n \"status\": true\n },\n \"dkim_record\": {\n \"host_name\": \"mail._domainkey\",\n \"type\": \"TXT\",\n \"value\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GN...\",\n \"status\": true\n },\n \"dmarc_record\": {\n \"host_name\": \"_dmarc\",\n \"type\": \"TXT\",\n \"value\": \"v=DMARC1; p=quarantine; rua=mailto:dmarc@mycompany.com\",\n \"status\": true\n }\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "184d536e-335a-4ef0-8445-30b9081f5725", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "85cfda0d-d298-48b3-8a8f-fcdc75ac72c2", "name": "deleteDomain - default", "request": { "urlPathTemplate": "/senders/domains/{domainName}", "method": "DELETE", "pathParameters": { "domainName": { "equalTo": "domainName" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "85cfda0d-d298-48b3-8a8f-fcdc75ac72c2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "9028b6d6-1ed0-4272-bf1a-30fca4d35a1b", "name": "authenticateDomain - default", "request": { "urlPathTemplate": "/senders/domains/{domainName}/authenticate", "method": "PUT", "pathParameters": { "domainName": { "equalTo": "domainName" } } }, "response": { "status": 200, "body": "{\n \"domain_name\": \"mycompany.com\",\n \"message\": \"Domain has been authenticated successfully.\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "9028b6d6-1ed0-4272-bf1a-30fca4d35a1b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "71fd7de8-a010-43ca-bce7-8d0788df718a", "name": "getWebhooks - default", "request": { "urlPathTemplate": "/webhooks", "method": "GET" }, "response": { "status": 200, "body": "{\n \"webhooks\": [\n {\n \"auth\": {\n \"token\": \"test-auth-token1234\",\n \"type\": \"bearer\"\n },\n \"batched\": true,\n \"channel\": \"email\",\n \"createdAt\": \"2016-07-18T12:30:09Z\",\n \"description\": \"Webhook triggered on campaign openings\",\n \"events\": [\n \"opened\"\n ],\n \"headers\": [\n {\n \"key\": \"cf-secret\",\n \"value\": \"test-header-value\"\n }\n ],\n \"id\": 9864,\n \"modifiedAt\": \"2016-07-18T16:00:50Z\",\n \"type\": \"transactional\",\n \"url\": \"https://example.domain.com/webhook/events/kzfxxxxxxxx0uyo1\"\n },\n {\n \"auth\": {\n \"token\": \"test-auth-token1234\",\n \"type\": \"bearer\"\n },\n \"batched\": true,\n \"channel\": \"sms\",\n \"createdAt\": \"2017-02-20T14:30:00Z\",\n \"description\": \"Webhook triggered on campaign hard bounces\",\n \"events\": [\n \"hardBounces\"\n ],\n \"headers\": [\n {\n \"key\": \"cf-secret\",\n \"value\": \"test-header-value\"\n }\n ],\n \"id\": 22770,\n \"modifiedAt\": \"2017-02-20T19:00:00Z\",\n \"type\": \"marketing\",\n \"url\": \"http://exmaple.domain.com/15kxxxxxn1\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "71fd7de8-a010-43ca-bce7-8d0788df718a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "657ec845-de7a-4389-887a-888df91d2433", "name": "createWebhook - default", "request": { "urlPathTemplate": "/webhooks", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "657ec845-de7a-4389-887a-888df91d2433", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0bf6e8dd-41ac-4605-b444-f39fff877649", "name": "This endpoint will submit a request to get the history of webhooks in the\nCSV file. The link to download the CSV file will be sent to the webhook that\nwas provided in the notifyURL. - default", "request": { "urlPathTemplate": "/webhooks/export", "method": "POST" }, "response": { "status": 202, "body": "{\n \"processId\": 78\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0bf6e8dd-41ac-4605-b444-f39fff877649", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "adc43c28-964b-4170-aee2-5bb24add0d04", "name": "getWebhook - default", "request": { "urlPathTemplate": "/webhooks/{webhookId}", "method": "GET", "pathParameters": { "webhookId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"auth\": {\n \"token\": \"test-auth-token1234\",\n \"type\": \"bearer\"\n },\n \"batched\": true,\n \"channel\": \"sms\",\n \"createdAt\": \"2016-06-07T09:10:10Z\",\n \"description\": \"Webhook triggered on campaign openings and addition of lists\",\n \"events\": [\n \"listAdditions\",\n \"opened\"\n ],\n \"headers\": [\n {\n \"key\": \"cf-secret\",\n \"value\": \"test-header-value\"\n }\n ],\n \"id\": 7287,\n \"modifiedAt\": \"2016-06-08T11:30:00Z\",\n \"type\": \"marketing\",\n \"url\": \"http://example.domain.com/1brxxxxxx5p1\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "adc43c28-964b-4170-aee2-5bb24add0d04", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ffcb1664-4c31-4340-a525-2b616cf4334c", "name": "updateWebhook - default", "request": { "urlPathTemplate": "/webhooks/{webhookId}", "method": "PUT", "pathParameters": { "webhookId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "ffcb1664-4c31-4340-a525-2b616cf4334c", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "be23bfc5-4a58-4cb4-8191-aee4cb8f244f", "name": "deleteWebhook - default", "request": { "urlPathTemplate": "/webhooks/{webhookId}", "method": "DELETE", "pathParameters": { "webhookId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "be23bfc5-4a58-4cb4-8191-aee4cb8f244f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "2a8a03cd-cea2-4501-94e0-c2dccdd68f00", "name": "Get all external feeds - default", "request": { "urlPathTemplate": "/feeds", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 18,\n \"feeds\": [\n {\n \"id\": \"b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6\",\n \"name\": \"Product Catalog Feed\",\n \"alias\": \"product_catalog_feed\",\n \"url\": \"https://api.example.com/products\",\n \"authType\": \"noAuth\",\n \"username\": \"apiuser\",\n \"password\": \"apipass\",\n \"token\": \"abc123token456\",\n \"maxRetries\": 3,\n \"cache\": true,\n \"isInternal\": false,\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer xyz789\"\n }\n ],\n \"createdAt\": \"2025-09-18T13:29:27Z\",\n \"modifiedAt\": \"2025-09-18T13:29:27Z\"\n },\n {\n \"id\": \"c2d3e4f5-a6b7-48c9-90d1-e2f3a4b5c6d7\",\n \"name\": \"Blog News Feed\",\n \"alias\": \"blog_news_feed\",\n \"url\": \"https://blog.example.com/api/posts\",\n \"authType\": \"noAuth\",\n \"username\": \"apiuser\",\n \"password\": \"apipass\",\n \"token\": \"abc123token456\",\n \"maxRetries\": 3,\n \"cache\": true,\n \"isInternal\": true,\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer xyz789\"\n }\n ],\n \"createdAt\": \"2025-09-17T16:03:25Z\",\n \"modifiedAt\": \"2025-09-17T16:03:25Z\"\n },\n {\n \"id\": \"d3e4f5a6-b7c8-49d0-91e2-f3a4b5c6d7e8\",\n \"name\": \"Public Data Feed\",\n \"alias\": \"public_data_feed\",\n \"url\": \"https://jsonplaceholder.typicode.com/posts\",\n \"authType\": \"noAuth\",\n \"username\": \"apiuser\",\n \"password\": \"apipass\",\n \"token\": \"abc123token456\",\n \"maxRetries\": 3,\n \"cache\": true,\n \"isInternal\": true,\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer xyz789\"\n }\n ],\n \"createdAt\": \"2025-09-05T09:06:42Z\",\n \"modifiedAt\": \"2025-09-05T09:06:42Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "2a8a03cd-cea2-4501-94e0-c2dccdd68f00", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "6feaee25-9e8b-4798-b9ee-ae7b3aad1442", "name": "Create external feed - default", "request": { "urlPathTemplate": "/feeds", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6feaee25-9e8b-4798-b9ee-ae7b3aad1442", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "2239ff35-3a80-42f1-b822-81e1d785db03", "name": "Get external feed details - default", "request": { "urlPathTemplate": "/feeds/{uuid}", "method": "GET", "pathParameters": { "uuid": { "equalTo": "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6" } } }, "response": { "status": 200, "body": "{\n \"id\": \"b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6\",\n \"name\": \"Product Catalog Feed\",\n \"url\": \"https://api.example.com/products\",\n \"authType\": \"noAuth\",\n \"personalization\": false,\n \"defaultAttr\": \"\",\n \"defaultContact\": \"\",\n \"maxRetries\": 0,\n \"cache\": false,\n \"createdAt\": \"2025-09-18T13:29:27Z\",\n \"modifiedAt\": \"2025-09-18T13:29:27Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "2239ff35-3a80-42f1-b822-81e1d785db03", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c1cb8e28-7845-4479-a233-737a81218df9", "name": "Update external feed - default", "request": { "urlPathTemplate": "/feeds/{uuid}", "method": "PUT", "pathParameters": { "uuid": { "equalTo": "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "c1cb8e28-7845-4479-a233-737a81218df9", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "63a2125b-2244-41b0-8f75-6e2eb3cfb682", "name": "Delete external feed - default", "request": { "urlPathTemplate": "/feeds/{uuid}", "method": "DELETE", "pathParameters": { "uuid": { "equalTo": "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "63a2125b-2244-41b0-8f75-6e2eb3cfb682", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "03da01c2-0cff-47d2-996c-4317cabb22c4", "name": "Create/Update object records in bulk - default", "request": { "urlPathTemplate": "/objects/{object_type}/batch/upsert", "method": "POST", "pathParameters": { "object_type": { "equalTo": "vehicle" } } }, "response": { "status": 202, "body": "{\n \"message\": \"Batch object records are being processed\",\n \"processId\": 21\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "03da01c2-0cff-47d2-996c-4317cabb22c4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "90e40ddc-ba7b-4979-8f3d-67bcfe9be80d", "name": "Get the list of object records and total records count for an object. - default", "request": { "urlPathTemplate": "/objects/{object_type}/records", "method": "GET", "pathParameters": { "object_type": { "equalTo": "vehicle" } } }, "response": { "status": 200, "body": "{\n \"count\": 350,\n \"records\": [\n {\n \"associations\": [\n {\n \"object_type\": \"garage\",\n \"records\": [\n {\n \"identifiers\": {\n \"id\": 12345\n }\n }\n ]\n }\n ],\n \"attributes\": {\n \"color\": \"Black\",\n \"engine_type\": \"Hybrid\",\n \"make\": \"Toyoto\",\n \"model\": \"Corolla\",\n \"year\": 2020\n },\n \"createdAt\": \"2025-07-22T10:20:30Z\",\n \"identifiers\": {\n \"ext_id\": \"507f1f77bc\",\n \"id\": 16789\n },\n \"updatedAt\": \"2025-07-22T10:20:30Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "90e40ddc-ba7b-4979-8f3d-67bcfe9be80d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "dc28fc32-e60d-4ec0-a256-912ae9ca2cbd", "name": "Delete multiple object records (up to 1000) asynchronously - default", "request": { "urlPathTemplate": "/objects/{object_type}/batch/delete", "method": "POST", "pathParameters": { "object_type": { "equalTo": "vehicle" } } }, "response": { "status": 202, "body": "{\n \"processId\": 21,\n \"message\": \"Batch object records are being processed for deletion.\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "dc28fc32-e60d-4ec0-a256-912ae9ca2cbd", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "8729f948-4808-4d8f-b027-70b35a734218", "name": "Get all the contacts - default", "request": { "urlPathTemplate": "/contacts", "method": "GET" }, "response": { "status": 200, "body": "{\n \"contacts\": [\n {\n \"attributes\": {},\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"email\": \"contact1@example.com\",\n \"emailBlacklisted\": true,\n \"id\": 247,\n \"listIds\": [\n 43,\n 58\n ],\n \"listUnsubscribed\": [\n 1000000\n ],\n \"modifiedAt\": \"2017-05-01T17:05:03Z\",\n \"smsBlacklisted\": true\n },\n {\n \"attributes\": {},\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"email\": \"33058407248@mailin-sms.com\",\n \"emailBlacklisted\": true,\n \"id\": 245,\n \"listIds\": [\n 43,\n 61,\n 58\n ],\n \"listUnsubscribed\": [\n 1000000\n ],\n \"modifiedAt\": \"2017-05-01T17:05:03Z\",\n \"smsBlacklisted\": false\n }\n ],\n \"count\": 3\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8729f948-4808-4d8f-b027-70b35a734218", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "fe3c55db-75e2-4d78-85c0-eaed9f642c83", "name": "Create a contact - default", "request": { "urlPathTemplate": "/contacts", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 21\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fe3c55db-75e2-4d78-85c0-eaed9f642c83", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "dd0aa44d-f601-4c28-8481-1c0b25bb46aa", "name": "List all attributes - default", "request": { "urlPathTemplate": "/contacts/attributes", "method": "GET" }, "response": { "status": 200, "body": "{\n \"attributes\": [\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"normal\",\n \"enumeration\": [\n {\n \"label\": \"Women\",\n \"value\": 1\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\"\n ],\n \"name\": \"LASTNAME\",\n \"type\": \"text\"\n },\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"normal\",\n \"enumeration\": [\n {\n \"label\": \"Women\",\n \"value\": 1\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\"\n ],\n \"name\": \"FIRSTNAME\",\n \"type\": \"text\"\n },\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"normal\",\n \"enumeration\": [\n {\n \"label\": \"Women\",\n \"value\": 1\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\"\n ],\n \"name\": \"DOB\",\n \"type\": \"date\"\n },\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"category\",\n \"enumeration\": [\n {\n \"label\": \"Men\",\n \"value\": 1\n },\n {\n \"label\": \"Women\",\n \"value\": 2\n },\n {\n \"label\": \"Kid\",\n \"value\": 3\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\"\n ],\n \"name\": \"GENDER\",\n \"type\": \"text\"\n },\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"normal\",\n \"enumeration\": [\n {\n \"label\": \"Women\",\n \"value\": 1\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\"\n ],\n \"name\": \"BDO\",\n \"type\": \"user\"\n },\n {\n \"calculatedValue\": \"COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]\",\n \"category\": \"normal\",\n \"enumeration\": [\n {\n \"label\": \"Women\",\n \"value\": 1\n }\n ],\n \"multiCategoryOptions\": [\n \"USA\",\n \"India\",\n \"France\"\n ],\n \"name\": \"COUNTRY\",\n \"type\": \"multiple-choice\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "dd0aa44d-f601-4c28-8481-1c0b25bb46aa", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "1253fdcb-3d6c-4957-88ab-df297d7154ab", "name": "Create contact attribute - default", "request": { "urlPathTemplate": "/contacts/attributes/{attributeCategory}/{attributeName}", "method": "POST", "pathParameters": { "attributeCategory": { "equalTo": "normal" }, "attributeName": { "equalTo": "attributeName" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "1253fdcb-3d6c-4957-88ab-df297d7154ab", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f02e59a5-f5b5-400d-8697-22eace5165c5", "name": "Update contact attribute - default", "request": { "urlPathTemplate": "/contacts/attributes/{attributeCategory}/{attributeName}", "method": "PUT", "pathParameters": { "attributeCategory": { "equalTo": "category" }, "attributeName": { "equalTo": "attributeName" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "f02e59a5-f5b5-400d-8697-22eace5165c5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "eed9112c-42ea-4dba-a3c1-5bc5eea04b6a", "name": "Delete an attribute - default", "request": { "urlPathTemplate": "/contacts/attributes/{attributeCategory}/{attributeName}", "method": "DELETE", "pathParameters": { "attributeCategory": { "equalTo": "normal" }, "attributeName": { "equalTo": "attributeName" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "eed9112c-42ea-4dba-a3c1-5bc5eea04b6a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "827de4b0-dfdc-45c9-a27a-819a6acaece3", "name": "Delete a multiple-choice attribute option - default", "request": { "urlPathTemplate": "/contacts/attributes/{attributeType}/{multipleChoiceAttribute}/{multipleChoiceAttributeOption}", "method": "DELETE", "pathParameters": { "attributeType": { "equalTo": "multiple-choice" }, "multipleChoiceAttribute": { "equalTo": "multipleChoiceAttribute" }, "multipleChoiceAttributeOption": { "equalTo": "multipleChoiceAttributeOption" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "827de4b0-dfdc-45c9-a27a-819a6acaece3", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6ba8cd16-ea25-49a7-8288-e0cf22a8b065", "name": "Update multiple contacts - default", "request": { "urlPathTemplate": "/contacts/batch", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "6ba8cd16-ea25-49a7-8288-e0cf22a8b065", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "2b7fdfe7-8f83-41bd-81d2-b42f70ff4603", "name": "Create Contact via DOI (Double-Opt-In) Flow - default", "request": { "urlPathTemplate": "/contacts/doubleOptinConfirmation", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "2b7fdfe7-8f83-41bd-81d2-b42f70ff4603", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1a2d075b-a8de-4135-b0c9-58bcfe31c7e4", "name": "Export contacts - default", "request": { "urlPathTemplate": "/contacts/export", "method": "POST" }, "response": { "status": 202, "body": "{\n \"processId\": 78\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1a2d075b-a8de-4135-b0c9-58bcfe31c7e4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c175e62d-23d7-4d5a-bc46-7093ac21de08", "name": "Get all folders - default", "request": { "urlPathTemplate": "/contacts/folders", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"folders\": [\n {\n \"id\": 42,\n \"name\": \"Ninja_Form\",\n \"totalBlacklisted\": 98,\n \"totalSubscribers\": 4567,\n \"uniqueSubscribers\": 4665\n },\n {\n \"id\": 29,\n \"name\": \"Prestashop\",\n \"totalBlacklisted\": 10,\n \"totalSubscribers\": 6543,\n \"uniqueSubscribers\": 6553\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c175e62d-23d7-4d5a-bc46-7093ac21de08", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "40d55e83-c362-440b-9ad3-3cbb47ed0eb0", "name": "Create a folder - default", "request": { "urlPathTemplate": "/contacts/folders", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "40d55e83-c362-440b-9ad3-3cbb47ed0eb0", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "64a96da1-15c5-426f-a455-f6ec46ff0434", "name": "Returns a folder's details - default", "request": { "urlPathTemplate": "/contacts/folders/{folderId}", "method": "GET", "pathParameters": { "folderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"id\": 1,\n \"name\": \"Client_Folder\",\n \"totalBlacklisted\": 987,\n \"totalSubscribers\": 16778,\n \"uniqueSubscribers\": 17765\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "64a96da1-15c5-426f-a455-f6ec46ff0434", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "701dc90d-1130-42e1-93d3-8ef73e8f8596", "name": "Update a folder - default", "request": { "urlPathTemplate": "/contacts/folders/{folderId}", "method": "PUT", "pathParameters": { "folderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "701dc90d-1130-42e1-93d3-8ef73e8f8596", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a33a22a6-f7ae-41f1-9646-c37d999a9421", "name": "Delete a folder (and all its lists) - default", "request": { "urlPathTemplate": "/contacts/folders/{folderId}", "method": "DELETE", "pathParameters": { "folderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a33a22a6-f7ae-41f1-9646-c37d999a9421", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1bbaf637-2edd-4ded-8338-3f42e8e93b45", "name": "Get lists in a folder - default", "request": { "urlPathTemplate": "/contacts/folders/{folderId}/lists", "method": "GET", "pathParameters": { "folderId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"count\": 3,\n \"lists\": [\n {\n \"id\": 46,\n \"name\": \"Reactiv\",\n \"totalBlacklisted\": 0,\n \"totalSubscribers\": 7655,\n \"uniqueSubscribers\": 7655\n },\n {\n \"id\": 41,\n \"name\": \"NY_Area\",\n \"totalBlacklisted\": 23,\n \"totalSubscribers\": 3654,\n \"uniqueSubscribers\": 3677\n },\n {\n \"id\": 22,\n \"name\": \"VIP_Customer\",\n \"totalBlacklisted\": 72,\n \"totalSubscribers\": 8753,\n \"uniqueSubscribers\": 8826\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1bbaf637-2edd-4ded-8338-3f42e8e93b45", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c104d034-1156-452e-a1f5-90baae3a120e", "name": "Import contacts - default", "request": { "urlPathTemplate": "/contacts/import", "method": "POST" }, "response": { "status": 202, "body": "{\n \"processId\": 78\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c104d034-1156-452e-a1f5-90baae3a120e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ede870d3-ebf8-4b09-851f-f8abb13c3b81", "name": "Get all the lists - default", "request": { "urlPathTemplate": "/contacts/lists", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"lists\": [\n {\n \"id\": 53,\n \"name\": \"Spanish_Speakers\",\n \"totalBlacklisted\": 65,\n \"totalSubscribers\": 5432,\n \"uniqueSubscribers\": 5497,\n \"folderId\": 1\n },\n {\n \"id\": 50,\n \"name\": \"Other\",\n \"totalBlacklisted\": 765,\n \"totalSubscribers\": 10976,\n \"uniqueSubscribers\": 11741,\n \"folderId\": 2\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ede870d3-ebf8-4b09-851f-f8abb13c3b81", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "ecaaf193-0526-47f7-a447-6866f25d6a35", "name": "Create a list - default", "request": { "urlPathTemplate": "/contacts/lists", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ecaaf193-0526-47f7-a447-6866f25d6a35", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d2bcf613-ab25-4a1d-acfc-f9189c9abdce", "name": "Get a list's details - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}", "method": "GET", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"id\": 12,\n \"name\": \"Newsletter_Weekly\",\n \"totalBlacklisted\": 63,\n \"totalSubscribers\": 6533,\n \"uniqueSubscribers\": 6596,\n \"campaignStats\": [\n {\n \"campaignId\": 15,\n \"stats\": {\n \"appleMppOpens\": 10,\n \"clickers\": 789,\n \"complaints\": 0,\n \"deferred\": 0,\n \"delivered\": 6632,\n \"estimatedViews\": 560,\n \"hardBounces\": 4,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 6645,\n \"softBounces\": 34,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 701,\n \"uniqueViews\": 3442,\n \"unsubscriptions\": 4,\n \"viewed\": 4322\n }\n },\n {\n \"campaignId\": 45,\n \"stats\": {\n \"appleMppOpens\": 10,\n \"clickers\": 788,\n \"complaints\": 1,\n \"deferred\": 0,\n \"delivered\": 4078,\n \"estimatedViews\": 560,\n \"hardBounces\": 2,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 4334,\n \"softBounces\": 18,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 654,\n \"uniqueViews\": 987,\n \"unsubscriptions\": 4,\n \"viewed\": 1555\n }\n }\n ],\n \"createdAt\": \"2016-02-26T11:56:08Z\",\n \"dynamicList\": false,\n \"folderId\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d2bcf613-ab25-4a1d-acfc-f9189c9abdce", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fd940864-d48a-47f4-8db8-5960a7657dcc", "name": "Update a list - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}", "method": "PUT", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "fd940864-d48a-47f4-8db8-5960a7657dcc", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f9aace2d-f1ee-48cf-9a00-2ce8a8e876de", "name": "Delete a list - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}", "method": "DELETE", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "f9aace2d-f1ee-48cf-9a00-2ce8a8e876de", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1e736496-14de-4379-b319-5857e47950dc", "name": "Get contacts in a list - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}/contacts", "method": "GET", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"contacts\": [\n {\n \"attributes\": {},\n \"createdAt\": \"2017-05-12T12:30:00Z\",\n \"email\": \"alex.pain@example.com\",\n \"emailBlacklisted\": false,\n \"id\": 45,\n \"listIds\": [\n 12,\n 9,\n 20\n ],\n \"listUnsubscribed\": [\n 1,\n 2\n ],\n \"modifiedAt\": \"2017-05-12T12:30:00Z\",\n \"smsBlacklisted\": true\n },\n {\n \"attributes\": {},\n \"createdAt\": \"2017-05-12T12:30:00Z\",\n \"email\": \"john.smith@example.com\",\n \"emailBlacklisted\": true,\n \"id\": 32,\n \"listIds\": [\n 12\n ],\n \"listUnsubscribed\": [\n 1\n ],\n \"modifiedAt\": \"2017-05-12T12:30:00Z\",\n \"smsBlacklisted\": false\n },\n {\n \"attributes\": {},\n \"createdAt\": \"2017-05-12T12:30:00Z\",\n \"email\": \"helen.rose@example.com\",\n \"emailBlacklisted\": true,\n \"id\": 65,\n \"listIds\": [\n 12,\n 9,\n 20\n ],\n \"listUnsubscribed\": [\n 1\n ],\n \"modifiedAt\": \"2017-05-12T12:30:00Z\",\n \"smsBlacklisted\": false\n }\n ],\n \"count\": 17655\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1e736496-14de-4379-b319-5857e47950dc", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f1dbcb2f-9c0d-4ccd-a750-28e2c2f9e6f9", "name": "Add existing contacts to a list - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}/contacts/add", "method": "POST", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 201, "body": "{\n \"contacts\": {\n \"failure\": [\n \"jeff32@example.com, jim56@example.com\"\n ],\n \"processId\": 78,\n \"success\": [\n \"success\"\n ],\n \"total\": 27\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "f1dbcb2f-9c0d-4ccd-a750-28e2c2f9e6f9", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "36e0a4db-6281-4b17-bcbe-d10a330348a5", "name": "Delete a contact from a list - default", "request": { "urlPathTemplate": "/contacts/lists/{listId}/contacts/remove", "method": "POST", "pathParameters": { "listId": { "equalTo": "1000000" } } }, "response": { "status": 201, "body": "{\n \"contacts\": {\n \"failure\": [\n \"jeff32@example.com, jim56@example.com\"\n ],\n \"processId\": 78,\n \"success\": [\n \"success\"\n ],\n \"total\": 27\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "36e0a4db-6281-4b17-bcbe-d10a330348a5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "dd30aa5c-59ad-4ff0-a95f-bf685d7b279e", "name": "Get all the segments - default", "request": { "urlPathTemplate": "/contacts/segments", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"segments\": [\n {\n \"categoryName\": \"Name1\",\n \"id\": 53,\n \"segmentName\": \"Segment1\",\n \"updatedAt\": \"2017-03-12T12:30:00Z\"\n },\n {\n \"categoryName\": \"Name2\",\n \"id\": 50,\n \"segmentName\": \"Segment2\",\n \"updatedAt\": \"2017-03-12T12:30:00Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "dd30aa5c-59ad-4ff0-a95f-bf685d7b279e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "5a0e7075-a413-4c22-a2bf-aa2f8e383d6d", "name": "Get a contact's details - default", "request": { "urlPathTemplate": "/contacts/{identifier}", "method": "GET", "pathParameters": { "identifier": { "equalTo": "identifier" } } }, "response": { "status": 200, "body": "{\n \"attributes\": {},\n \"createdAt\": \"2017-05-02T16:40:31Z\",\n \"email\": \"peggy.rain@example.com\",\n \"emailBlacklisted\": false,\n \"id\": 42,\n \"listIds\": [\n 40\n ],\n \"listUnsubscribed\": [\n 1000000\n ],\n \"modifiedAt\": \"2017-05-02T16:40:31Z\",\n \"smsBlacklisted\": false,\n \"statistics\": {\n \"clicked\": [\n {\n \"campaignId\": 21,\n \"links\": [\n {\n \"count\": 2,\n \"eventTime\": \"2016-05-03T21:25:01Z\",\n \"ip\": \"66.249.93.118\",\n \"url\": \"https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=brevo&utm_campaign=test_camp&utm_medium=email\"\n }\n ]\n }\n ],\n \"complaints\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"delivered\": [\n {\n \"campaignId\": 21,\n \"eventTime\": \"2016-05-03T21:24:56Z\"\n }\n ],\n \"hardBounces\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"messagesSent\": [\n {\n \"campaignId\": 21,\n \"eventTime\": \"2016-05-03T20:15:13Z\"\n },\n {\n \"campaignId\": 42,\n \"eventTime\": \"2016-10-17T10:30:01Z\"\n }\n ],\n \"opened\": [\n {\n \"campaignId\": 21,\n \"count\": 2,\n \"eventTime\": \"2016-05-03T21:24:56Z\",\n \"ip\": \"66.249.93.118\"\n },\n {\n \"campaignId\": 68,\n \"count\": 1,\n \"eventTime\": \"2017-01-30T13:56:40Z\",\n \"ip\": \"66.249.93.217\"\n }\n ],\n \"softBounces\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"transacAttributes\": [\n {}\n ],\n \"unsubscriptions\": {\n \"adminUnsubscription\": [\n {\n \"eventTime\": \"2017-03-12T20:15:13Z\",\n \"ip\": \"165.87.3.15\"\n }\n ],\n \"userUnsubscription\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\",\n \"ip\": \"165.87.3.15\"\n }\n ]\n }\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5a0e7075-a413-4c22-a2bf-aa2f8e383d6d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "75a6a0e6-ae00-42cb-82ae-0bbe1f8bd2d1", "name": "Update a contact - default", "request": { "urlPathTemplate": "/contacts/{identifier}", "method": "PUT", "pathParameters": { "identifier": { "equalTo": "identifier" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "75a6a0e6-ae00-42cb-82ae-0bbe1f8bd2d1", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fb8d40ed-00fd-4acc-88a7-32580773691f", "name": "Delete a contact - default", "request": { "urlPathTemplate": "/contacts/{identifier}", "method": "DELETE", "pathParameters": { "identifier": { "equalTo": "identifier" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "fb8d40ed-00fd-4acc-88a7-32580773691f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "9797e88c-e80c-4130-9605-8986d5de0403", "name": "Get email campaigns' statistics for a contact - default", "request": { "urlPathTemplate": "/contacts/{identifier}/campaignStats", "method": "GET", "pathParameters": { "identifier": { "equalTo": "identifier" } } }, "response": { "status": 200, "body": "{\n \"clicked\": [\n {\n \"campaignId\": 21,\n \"links\": [\n {\n \"count\": 2,\n \"eventTime\": \"2016-05-03T21:25:01Z\",\n \"ip\": \"66.249.93.118\",\n \"url\": \"https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=brevo&utm_campaign=test_camp&utm_medium=email\"\n }\n ]\n }\n ],\n \"complaints\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"delivered\": [\n {\n \"campaignId\": 21,\n \"eventTime\": \"2016-05-03T21:24:56Z\"\n }\n ],\n \"hardBounces\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"messagesSent\": [\n {\n \"campaignId\": 21,\n \"eventTime\": \"2016-05-03T20:15:13Z\"\n },\n {\n \"campaignId\": 42,\n \"eventTime\": \"2016-10-17T10:30:01Z\"\n },\n {\n \"campaignId\": 45,\n \"eventTime\": \"2016-11-09T11:45:02Z\"\n }\n ],\n \"opened\": [\n {\n \"campaignId\": 21,\n \"count\": 2,\n \"eventTime\": \"2016-05-03T21:24:56Z\",\n \"ip\": \"66.249.93.118\"\n },\n {\n \"campaignId\": 45,\n \"count\": 1,\n \"eventTime\": \"2017-01-30T13:56:40Z\",\n \"ip\": \"66.249.93.217\"\n }\n ],\n \"softBounces\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\"\n }\n ],\n \"transacAttributes\": [\n {\n \"orderDate\": \"2017-03-12\",\n \"orderId\": 248,\n \"orderPrice\": 24.99\n }\n ],\n \"unsubscriptions\": {\n \"adminUnsubscription\": [\n {\n \"eventTime\": \"2017-03-12T20:15:13Z\",\n \"ip\": \"165.87.3.15\"\n }\n ],\n \"userUnsubscription\": [\n {\n \"campaignId\": 3,\n \"eventTime\": \"2017-03-12T20:15:13Z\",\n \"ip\": \"165.87.3.15\"\n }\n ]\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "9797e88c-e80c-4130-9605-8986d5de0403", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "989a2ce4-8788-48cc-963d-3d86cc2b2dd2", "name": "Sets agent’s status to online for 2-3 minutes - default", "request": { "urlPathTemplate": "/conversations/agentOnlinePing", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "989a2ce4-8788-48cc-963d-3d86cc2b2dd2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0b2458f6-3c0f-4f03-9f63-8051466d793b", "name": "Send a message as an agent - default", "request": { "urlPathTemplate": "/conversations/messages", "method": "POST" }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1482512803740,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Hello! How can I help you?\",\n \"id\": \"eYBEm3gq3zc5ayE2g\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": false,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Hello! How can I help you?\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0b2458f6-3c0f-4f03-9f63-8051466d793b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "73c7e27f-534f-4bff-ae89-6508af694971", "name": "Get a message - default", "request": { "urlPathTemplate": "/conversations/messages/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1482512803740,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Hello! How can I help you?\",\n \"id\": \"eYBEm3gq3zc5ayE2g\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": false,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Hello! How can I help you?\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "73c7e27f-534f-4bff-ae89-6508af694971", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "92155bd1-c19b-4aad-99c9-8a69133fc185", "name": "Update a message sent by an agent - default", "request": { "urlPathTemplate": "/conversations/messages/{id}", "method": "PUT", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1482512803740,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Hello! How can I help you?\",\n \"id\": \"eYBEm3gq3zc5ayE2g\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": false,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Hello! How can I help you?\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "92155bd1-c19b-4aad-99c9-8a69133fc185", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "55448424-484f-42a8-b091-f8c24234f898", "name": "Delete a message sent by an agent - default", "request": { "urlPathTemplate": "/conversations/messages/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "55448424-484f-42a8-b091-f8c24234f898", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "7da39f40-5660-4486-b572-835f3f204973", "name": "Send an automated message to a visitor - default", "request": { "urlPathTemplate": "/conversations/pushedMessages", "method": "POST" }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1470222622433,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88\",\n \"id\": \"AXCR3k9bpSY7bpuh7\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": true,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "7da39f40-5660-4486-b572-835f3f204973", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "12a96082-f3dc-4674-b4a6-a2fc4b6aea92", "name": "Get an automated message - default", "request": { "urlPathTemplate": "/conversations/pushedMessages/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1470222622433,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88\",\n \"id\": \"AXCR3k9bpSY7bpuh7\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": true,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "12a96082-f3dc-4674-b4a6-a2fc4b6aea92", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "88f6c974-0fa5-4c85-bd4a-2c306144fb5a", "name": "Update an automated message - default", "request": { "urlPathTemplate": "/conversations/pushedMessages/{id}", "method": "PUT", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"agentId\": \"d9nKoegKSjmCtyK78\",\n \"agentName\": \"Liz\",\n \"agentUserpic\": \"https://www.brevo.com/\",\n \"attachments\": [\n {\n \"fileName\": \"fileName\",\n \"inlineId\": \"inlineId\",\n \"isImage\": true,\n \"isInline\": \"isInline\",\n \"size\": 1000000,\n \"url\": \"url\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"createdAt\": 1470222622433,\n \"file\": {\n \"filename\": \"conversations.png\",\n \"imageInfo\": {\n \"height\": 525,\n \"previewUrl\": \"https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/\",\n \"width\": 1129\n },\n \"isImage\": true,\n \"size\": 15538,\n \"url\": \"https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/\"\n },\n \"forwardedToSourceStatus\": {\n \"error\": \"error\",\n \"isSuccess\": true\n },\n \"from\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"html\": \"Your order has shipped! Here’s your tracking number: 9114 5847 4668 7775 9233 54\",\n \"id\": \"AXCR3k9bpSY7bpuh7\",\n \"integrations\": {\n \"key\": \"value\"\n },\n \"isBot\": true,\n \"isMissed\": false,\n \"isMissedByVisitor\": false,\n \"isPushed\": true,\n \"isTrigger\": false,\n \"rawUnsafeHtml\": \"Good morning!
How can I help you?\",\n \"receivedFrom\": \"SuperAwesomeHelpdesk\",\n \"replyTo\": {\n \"email\": \"email\",\n \"name\": \"name\"\n },\n \"sourceMessageId\": \"sourceMessageId\",\n \"subject\": \"Invitation to a meeting\",\n \"text\": \"Your order has shipped! Here’s your tracking number: 9114 5847 4668 7775 9233 54\",\n \"to\": [\n {\n \"email\": \"email\",\n \"name\": \"name\"\n }\n ],\n \"type\": \"agent\",\n \"visitorId\": \"kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "88f6c974-0fa5-4c85-bd4a-2c306144fb5a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a43cca1b-0cb5-4197-ad31-8ce0e455a7fe", "name": "Delete an automated message - default", "request": { "urlPathTemplate": "/conversations/pushedMessages/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a43cca1b-0cb5-4197-ad31-8ce0e455a7fe", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "27ddcd9f-5f2e-408f-a518-a4e395c047ee", "name": "Set visitor group assignment - default", "request": { "urlPathTemplate": "/conversations/visitorGroup", "method": "PUT" }, "response": { "status": 200, "body": "{\n \"groupId\": \"PjRBMhWGen6aRHjif\",\n \"visitorId\": \"AXCR3k9bpSY7bpuh7\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "27ddcd9f-5f2e-408f-a518-a4e395c047ee", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6e38c169-881b-465d-ae5b-201dfe4364a5", "name": "Return all your categories - default", "request": { "urlPathTemplate": "/categories", "method": "GET" }, "response": { "status": 200, "body": "{\n \"categories\": [\n {\n \"createdAt\": \"2021-12-31T11:42:35.638Z\",\n \"id\": \"C19\",\n \"isDeleted\": true,\n \"modifiedAt\": \"2022-03-03T14:48:31.867Z\",\n \"name\": \"Food\",\n \"url\": \"http://mydomain.com/category/food\"\n },\n {\n \"createdAt\": \"2021-12-31T11:42:35.638Z\",\n \"id\": \"C20\",\n \"isDeleted\": true,\n \"modifiedAt\": \"2022-03-03T14:48:31.867Z\",\n \"name\": \"clothing\",\n \"url\": \"http://mydomain.com/category/clothing\"\n }\n ],\n \"count\": 2\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6e38c169-881b-465d-ae5b-201dfe4364a5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "c1c0c1db-676d-40e5-954f-ce7abd8fa780", "name": "Create/Update a category - default", "request": { "urlPathTemplate": "/categories", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 21\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c1c0c1db-676d-40e5-954f-ce7abd8fa780", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3355346d-e446-4635-9316-d9de9c0c8459", "name": "Create categories in batch - default", "request": { "urlPathTemplate": "/categories/batch", "method": "POST" }, "response": { "status": 201, "body": "{\n \"createdCount\": 2,\n \"updatedCount\": 7\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3355346d-e446-4635-9316-d9de9c0c8459", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e9a3bc64-c4fb-42bc-a44c-51ff0565f57d", "name": "Get a category details - default", "request": { "urlPathTemplate": "/categories/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2017-05-12T12:30:00Z\",\n \"id\": \"C11\",\n \"isDeleted\": true,\n \"modifiedAt\": \"2017-05-12T12:30:00Z\",\n \"name\": \"Electronics\",\n \"url\": \"http://mydomain.com/category/clothing\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e9a3bc64-c4fb-42bc-a44c-51ff0565f57d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "4aa9f4f1-3b05-446e-a5c8-175ce020f7dd", "name": "Activate the eCommerce app - default", "request": { "urlPathTemplate": "/ecommerce/activate", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "4aa9f4f1-3b05-446e-a5c8-175ce020f7dd", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ef76fef3-dd84-4cf8-9fa5-ff136eea6618", "name": "Get attribution metrics for one or more Brevo campaigns or workflows - default", "request": { "urlPathTemplate": "/ecommerce/attribution/metrics", "method": "GET" }, "response": { "status": 200, "body": "{\n \"results\": [\n {\n \"averageBasket\": 3,\n \"conversionSource\": \"email_campaign\",\n \"id\": 1.1,\n \"ordersCount\": 300,\n \"revenue\": 900\n },\n {\n \"averageBasket\": 4,\n \"conversionSource\": \"email_campaign\",\n \"id\": 1.1,\n \"ordersCount\": 200,\n \"revenue\": 800\n }\n ],\n \"totals\": {\n \"averageBasket\": 3.4,\n \"ordersCount\": 500,\n \"revenue\": 1700\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ef76fef3-dd84-4cf8-9fa5-ff136eea6618", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "a673ac7e-f9a7-4c21-bd80-b49ff3c73efc", "name": "Get detailed attribution metrics for a single Brevo campaign or workflow - default", "request": { "urlPathTemplate": "/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}", "method": "GET", "pathParameters": { "conversionSource": { "equalTo": "email_campaign" }, "conversionSourceId": { "equalTo": "sale" } } }, "response": { "status": 200, "body": "{\n \"averageBasket\": 1.1,\n \"conversionSource\": \"email_campaign\",\n \"id\": 1.1,\n \"ordersCount\": 1.1,\n \"revenue\": 1.1,\n \"newCustomersCount\": 1.1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a673ac7e-f9a7-4c21-bd80-b49ff3c73efc", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d80e42ab-4376-47f6-9971-baead08cd9ec", "name": "Get attributed product sales for a single Brevo campaign or workflow - default", "request": { "urlPathTemplate": "/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}", "method": "GET", "pathParameters": { "conversionSource": { "equalTo": "email_campaign" }, "conversionSourceId": { "equalTo": "sale" } } }, "response": { "status": 200, "body": "{\n \"products\": [\n {\n \"id\": \"1\",\n \"imageUrl\": \"http://mydomain.com/product-absoulte-url/img.jpeg\",\n \"name\": \"Milky Way Galaxy\",\n \"ordersCount\": 200,\n \"price\": 1000,\n \"revenue\": 999.99,\n \"sku\": \"sku-1\",\n \"url\": \"https://mydomain.com/products/alpina-panoma-classic\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d80e42ab-4376-47f6-9971-baead08cd9ec", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ab816e77-ae78-42da-b0ac-c9e2a426dd38", "name": "Get the ISO 4217 compliant display currency code for your Brevo account - default", "request": { "urlPathTemplate": "/ecommerce/config/displayCurrency", "method": "GET" }, "response": { "status": 200, "body": "{\n \"code\": \"EUR\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ab816e77-ae78-42da-b0ac-c9e2a426dd38", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "c8c71b7b-bc9d-4d4f-83d0-1d4a57463596", "name": "Set the ISO 4217 compliant display currency code for your Brevo account - default", "request": { "urlPathTemplate": "/ecommerce/config/displayCurrency", "method": "POST" }, "response": { "status": 200, "body": "{\n \"code\": \"EUR\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c8c71b7b-bc9d-4d4f-83d0-1d4a57463596", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a36a1140-3b78-405a-bb99-4be25b0e6f61", "name": "Get order details - default", "request": { "urlPathTemplate": "/orders", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 1,\n \"orders\": [\n {\n \"amount\": 2000,\n \"billing\": {\n \"address\": \"Sec 62, Noida\",\n \"city\": \"Noida\",\n \"country\": \"India\",\n \"countryCode\": \"IN\",\n \"paymentMethod\": \"Net banking\",\n \"phone\": 9238283982,\n \"postCode\": 110001,\n \"region\": \"North India\"\n },\n \"contact_id\": 2,\n \"coupons\": [\n \"flat50\",\n \"flat40\"\n ],\n \"createdAt\": \"2021-12-31T11:42:35.638Z\",\n \"email\": \"testvisitor@sendinblue.com\",\n \"id\": \"order1803\",\n \"identifiers\": {\n \"ext_id\": \"ab12\",\n \"loyalty_subscription_id\": \"1234\"\n },\n \"products\": [\n {\n \"price\": 100,\n \"productId\": 21,\n \"quantity\": 2,\n \"quantityFloat\": 0,\n \"variantId\": \"P100\"\n },\n {\n \"price\": 100,\n \"productId\": 21,\n \"quantity\": 0,\n \"quantityFloat\": 2.52,\n \"variantId\": \"P15756\"\n }\n ],\n \"status\": \"complete\",\n \"storeId\": \"123\",\n \"updatedAt\": \"2022-03-03T14:48:31.867Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a36a1140-3b78-405a-bb99-4be25b0e6f61", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "7063107e-0ad5-4bbd-97ec-def7bdb05465", "name": "Managing the status of the order - default", "request": { "urlPathTemplate": "/orders/status", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "7063107e-0ad5-4bbd-97ec-def7bdb05465", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1d3a52e5-1eb4-4b21-9a58-9136f4d6cdda", "name": "Create orders in batch - default", "request": { "urlPathTemplate": "/orders/status/batch", "method": "POST" }, "response": { "status": 202, "body": "{\n \"batchId\": 1.1,\n \"count\": 17655\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1d3a52e5-1eb4-4b21-9a58-9136f4d6cdda", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fd7eae8c-354e-4a43-8cea-0aa947291dea", "name": "Return all your products - default", "request": { "urlPathTemplate": "/products", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"products\": [\n {\n \"categories\": [\n \"279638835374\",\n \"279502848174\"\n ],\n \"createdAt\": \"2022-06-30T10:29:16.078Z\",\n \"id\": \"P11\",\n \"imageUrl\": \"http://mydomain.com/product-absoulte-url/img.jpeg\",\n \"isDeleted\": true,\n \"metaInfo\": {\n \"brand\": \"addidas\",\n \"description\": \"Shoes for sports\"\n },\n \"modifiedAt\": \"2022-06-30T10:29:16.078Z\",\n \"name\": \"Alpina Panoma Classic\",\n \"parentId\": \"parentId\",\n \"price\": 49.95,\n \"s3Original\": \"https://img-ecom.mailinblue.com/path-to-original/img.jpg\",\n \"s3ThumbAnalytics\": \"https://img-ecom.mailinblue.com/path-to-analytics/img.jpg\",\n \"s3ThumbEditor\": \"https://img-ecom.mailinblue.com/path-to-editor/img.jpg\",\n \"sku\": \"186622-9\",\n \"stock\": 100,\n \"url\": \"https://mydomain.com/products/alpina-panoma-classic\"\n },\n {\n \"categories\": [\n \"2d79638835374\",\n \"27d9502848174\"\n ],\n \"createdAt\": \"2022-06-30T10:29:16.078Z\",\n \"id\": \"P11\",\n \"imageUrl\": \"http://mydomain.com/product-absoulte-url/img.jpeg\",\n \"isDeleted\": true,\n \"metaInfo\": {\n \"brand\": \"addidas\",\n \"description\": \"Shoes for sports\"\n },\n \"modifiedAt\": \"2022-06-30T10:29:16.078Z\",\n \"name\": \"Alpina Panoma Classic2\",\n \"parentId\": \"parentId\",\n \"price\": 49.95,\n \"s3Original\": \"https://img-ecom.mailinblue.com/path-to-original/img.jpg\",\n \"s3ThumbAnalytics\": \"https://img-ecom.mailinblue.com/path-to-analytics/img.jpg\",\n \"s3ThumbEditor\": \"https://img-ecom.mailinblue.com/path-to-editor/img.jpg\",\n \"sku\": \"186622-9\",\n \"stock\": 350,\n \"url\": \"https://mydomain.com/products/alpina-panoma-classic2\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fd7eae8c-354e-4a43-8cea-0aa947291dea", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "8a42981c-cdd8-404e-bdb0-edaac19b7e0c", "name": "Create/Update a product - default", "request": { "urlPathTemplate": "/products", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 21\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8a42981c-cdd8-404e-bdb0-edaac19b7e0c", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "5f2f0859-18a7-463c-bee7-4afb4ba092b0", "name": "Create products in batch - default", "request": { "urlPathTemplate": "/products/batch", "method": "POST" }, "response": { "status": 201, "body": "{\n \"createdCount\": 2,\n \"updatedCount\": 7\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5f2f0859-18a7-463c-bee7-4afb4ba092b0", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "dcc8be20-9ebc-41b7-a9e0-2e9b9004756a", "name": "Get a product's details - default", "request": { "urlPathTemplate": "/products/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"categories\": [\n \"categories\"\n ],\n \"createdAt\": \"2017-05-12T12:30:00Z\",\n \"id\": \"P11\",\n \"imageUrl\": \"http://mydomain.com/product-absoulte-url/img.jpeg\",\n \"isDeleted\": true,\n \"metaInfo\": {\n \"brand\": \"addidas\",\n \"description\": \"Shoes for sports\"\n },\n \"modifiedAt\": \"2017-05-12T12:30:00Z\",\n \"name\": \"Iphone 11\",\n \"parentId\": \"parentId\",\n \"price\": 1.1,\n \"s3Original\": \"s3Original\",\n \"s3ThumbAnalytics\": \"s3ThumbAnalytics\",\n \"s3ThumbEditor\": \"s3ThumbEditor\",\n \"sku\": \"sku\",\n \"stock\": 100,\n \"url\": \"http://mydomain.com/product/electronics/product1\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "dcc8be20-9ebc-41b7-a9e0-2e9b9004756a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e82388ef-e4d4-4ac5-874c-2f802a602bed", "name": "Create a product alert for a contact - default", "request": { "urlPathTemplate": "/products/{id}/alerts/{type}", "method": "POST", "pathParameters": { "id": { "equalTo": "id" }, "type": { "equalTo": "back_in_stock" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "e82388ef-e4d4-4ac5-874c-2f802a602bed", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1afa5f6e-118c-4482-b744-5ef2a9799cf5", "name": "Get all your coupon collections - default", "request": { "urlPathTemplate": "/couponCollections", "method": "GET" }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2023-01-06T05:03:47Z\",\n \"defaultCoupon\": \"10 OFF\",\n \"expirationDate\": \"2024-01-01T00:00:00Z\",\n \"id\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"name\": \"SummerPromotions\",\n \"remainingCoupons\": 5000,\n \"remainingCouponsAlert\": 5,\n \"remainingDaysAlert\": 5,\n \"totalCoupons\": 10000\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1afa5f6e-118c-4482-b744-5ef2a9799cf5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "e6cacd7a-7ba8-4b0a-822c-0d6971f40073", "name": "Create а coupon collection - default", "request": { "urlPathTemplate": "/couponCollections", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"23befbae-1505-47a8-bd27-e30ef739f32c\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e6cacd7a-7ba8-4b0a-822c-0d6971f40073", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "dff4a2fb-73ac-479f-ab4c-2c9110fd1537", "name": "Get a coupon collection by id - default", "request": { "urlPathTemplate": "/couponCollections/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2023-01-06T05:03:47Z\",\n \"defaultCoupon\": \"10 OFF\",\n \"expirationDate\": \"2024-01-01T00:00:00Z\",\n \"id\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"name\": \"SummerPromotions\",\n \"remainingCoupons\": 5000,\n \"remainingCouponsAlert\": 5,\n \"remainingDaysAlert\": 5,\n \"totalCoupons\": 10000\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "dff4a2fb-73ac-479f-ab4c-2c9110fd1537", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e28907c7-b011-4634-bb47-d32e210b128b", "name": "Update a coupon collection by id - default", "request": { "urlPathTemplate": "/couponCollections/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"defaultCoupon\": \"10 OFF\",\n \"id\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"name\": \"SummerPromotions\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e28907c7-b011-4634-bb47-d32e210b128b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "eef10e8c-75d8-4adc-9fb0-8c2daeb31145", "name": "Create coupons for a coupon collection - default", "request": { "urlPathTemplate": "/coupons", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "eef10e8c-75d8-4adc-9fb0-8c2daeb31145", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "35f2e6da-c185-4829-b6ce-3bd466f76681", "name": "Create a payment request - default", "request": { "urlPathTemplate": "/payments/requests", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 122,\n \"url\": \"https://pay.brevo.com/payment/6d4ec0b2b48ef803df4103ve\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "35f2e6da-c185-4829-b6ce-3bd466f76681", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "173baf22-0f60-411a-b5e3-f68c427c3a5d", "name": "Get payment request details - default", "request": { "urlPathTemplate": "/payments/requests/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "050db7b0-9bb7-4c1e-9c68-5a8dace8c1dc" } } }, "response": { "status": 200, "body": "{\n \"cart\": {\n \"currency\": \"EUR\",\n \"specificAmount\": 1200\n },\n \"configuration\": {\n \"customSuccessUrl\": \"https://my-company.com/payment-success\"\n },\n \"contactId\": 43,\n \"notification\": {\n \"channel\": \"email\",\n \"text\": \"Please pay for your yoga class.\"\n },\n \"numberOfRemindersSent\": 5,\n \"reference\": \"Invoice #INV0001\\n\",\n \"status\": \"paid\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "173baf22-0f60-411a-b5e3-f68c427c3a5d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "87ef813d-0336-4656-a5b5-e0899662397f", "name": "Delete a payment request. - default", "request": { "urlPathTemplate": "/payments/requests/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "9ae7d68a-565c-4695-9381-d8fb3e3a14cc" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "87ef813d-0336-4656-a5b5-e0899662397f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "aed029ff-9be1-4acb-9dcf-a4c3e218a560", "name": "Create an event - default", "request": { "urlPathTemplate": "/events", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "aed029ff-9be1-4acb-9dcf-a4c3e218a560", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "09aa7143-15a9-433c-a1e0-3444863bbf64", "name": "Get the list of all the events for the received emails. - default", "request": { "urlPathTemplate": "/inbound/events", "method": "GET" }, "response": { "status": 200, "body": "{\n \"events\": [\n {\n \"date\": \"2017-03-11T12:30:00Z\",\n \"recipient\": \"alexa@example.com\",\n \"sender\": \"john@example.com\",\n \"uuid\": \"1a825d56-029b-4a41-b8e4-1a825d56\"\n },\n {\n \"date\": \"2017-03-12T12:30:00Z\",\n \"recipient\": \"bob@example.com\",\n \"sender\": \"alice@example.com\",\n \"uuid\": \"1a825d56-029b-4a41-b8e4-61670463431b\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "09aa7143-15a9-433c-a1e0-3444863bbf64", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "ee4248db-9736-4af1-a32a-5a7de6f5328a", "name": "Fetch all events history for one particular received email. - default", "request": { "urlPathTemplate": "/inbound/events/{uuid}", "method": "GET", "pathParameters": { "uuid": { "equalTo": "uuid" } } }, "response": { "status": 200, "body": "{\n \"attachments\": [\n {\n \"contentLength\": 12345,\n \"contentType\": \"application/pdf\",\n \"name\": \"invoice.pdf\"\n }\n ],\n \"deliveredAt\": \"2017-03-12T12:31:00Z\",\n \"logs\": [\n {\n \"date\": \"2017-03-12T12:30:00Z\",\n \"type\": \"received\"\n },\n {\n \"date\": \"2017-03-12T12:30:04Z\",\n \"type\": \"webhookFailed\"\n },\n {\n \"date\": \"2017-03-12T12:31:04Z\",\n \"type\": \"webhookDelivered\"\n }\n ],\n \"messageId\": \"\",\n \"receivedAt\": \"2017-03-12T12:30:00Z\",\n \"recipient\": \"bob@example.com\",\n \"sender\": \"alice@example.com\",\n \"subject\": \"Re: Question about your API\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ee4248db-9736-4af1-a32a-5a7de6f5328a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3426b7cd-c7c6-4cd0-8359-916c1482c4a3", "name": "Retrieve inbound attachment with download token. - default", "request": { "urlPathTemplate": "/inbound/attachments/{downloadToken}", "method": "GET", "pathParameters": { "downloadToken": { "equalTo": "downloadToken" } } }, "response": { "status": 200, "body": "{\n \"key\": \"value\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3426b7cd-c7c6-4cd0-8359-916c1482c4a3", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b8273ac4-3d1a-4b9a-b003-bb49ef16337f", "name": "Get Active Balances API - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/active-balance", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"constraintType\": \"constraintType\",\n \"createdAt\": \"createdAt\",\n \"durationUnit\": \"durationUnit\",\n \"durationValue\": 1,\n \"id\": \"id\",\n \"slidingSchedule\": true,\n \"transactionType\": \"transactionType\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "b8273ac4-3d1a-4b9a-b003-bb49ef16337f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "7ed4ff5a-868f-45ef-a95a-550b62f69d5a", "name": "Get balance definition list - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"balanceAvailabilityDurationModifier\": \"startOfPeriod\",\n \"balanceAvailabilityDurationUnit\": \"balanceAvailabilityDurationUnit\",\n \"balanceAvailabilityDurationValue\": 1,\n \"balanceExpirationDate\": \"2024-01-15T09:30:00Z\",\n \"balanceOptionAmountOvertakingStrategy\": \"balanceOptionAmountOvertakingStrategy\",\n \"balanceOptionCreditRounding\": \"balanceOptionCreditRounding\",\n \"balanceOptionDebitRounding\": \"balanceOptionDebitRounding\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"deletedAt\": \"deletedAt\",\n \"description\": \"description\",\n \"id\": \"id\",\n \"imageRef\": \"imageRef\",\n \"maxAmount\": 1.1,\n \"maxCreditAmountLimit\": 1.1,\n \"maxDebitAmountLimit\": 1.1,\n \"meta\": {\n \"key\": \"value\"\n },\n \"minAmount\": 1.1,\n \"name\": \"name\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "7ed4ff5a-868f-45ef-a95a-550b62f69d5a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "9db15f6f-dd09-4033-bff7-9d94ef6ae471", "name": "Create balance definition - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"balanceAvailabilityDurationModifier\": \"startOfPeriod\",\n \"balanceAvailabilityDurationUnit\": \"balanceAvailabilityDurationUnit\",\n \"balanceAvailabilityDurationValue\": 1,\n \"balanceExpirationDate\": \"2024-01-15T09:30:00Z\",\n \"balanceOptionAmountOvertakingStrategy\": \"balanceOptionAmountOvertakingStrategy\",\n \"balanceOptionCreditRounding\": \"balanceOptionCreditRounding\",\n \"balanceOptionDebitRounding\": \"balanceOptionDebitRounding\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"deletedAt\": \"deletedAt\",\n \"description\": \"description\",\n \"id\": \"id\",\n \"imageRef\": \"imageRef\",\n \"maxAmount\": 1.1,\n \"maxCreditAmountLimit\": 1.1,\n \"maxDebitAmountLimit\": 1.1,\n \"meta\": {\n \"key\": \"value\"\n },\n \"minAmount\": 1.1,\n \"name\": \"name\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "9db15f6f-dd09-4033-bff7-9d94ef6ae471", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "5171ff4c-8ab1-4886-96b9-72845239dcb2", "name": "Get balance definition - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" } } }, "response": { "status": 200, "body": "{\n \"balanceAvailabilityDurationModifier\": \"startOfPeriod\",\n \"balanceAvailabilityDurationUnit\": \"balanceAvailabilityDurationUnit\",\n \"balanceAvailabilityDurationValue\": 1,\n \"balanceExpirationDate\": \"2024-01-15T09:30:00Z\",\n \"balanceOptionAmountOvertakingStrategy\": \"balanceOptionAmountOvertakingStrategy\",\n \"balanceOptionCreditRounding\": \"balanceOptionCreditRounding\",\n \"balanceOptionDebitRounding\": \"balanceOptionDebitRounding\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"deletedAt\": \"deletedAt\",\n \"description\": \"description\",\n \"id\": \"id\",\n \"imageRef\": \"imageRef\",\n \"maxAmount\": 1.1,\n \"maxCreditAmountLimit\": 1.1,\n \"maxDebitAmountLimit\": 1.1,\n \"meta\": {\n \"key\": \"value\"\n },\n \"minAmount\": 1.1,\n \"name\": \"name\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5171ff4c-8ab1-4886-96b9-72845239dcb2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1da76c71-d209-4641-9094-43a7214838ef", "name": "Update balance definition - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}", "method": "PUT", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" } } }, "response": { "status": 200, "body": "{\n \"balanceAvailabilityDurationModifier\": \"startOfPeriod\",\n \"balanceAvailabilityDurationUnit\": \"balanceAvailabilityDurationUnit\",\n \"balanceAvailabilityDurationValue\": 1,\n \"balanceExpirationDate\": \"2024-01-15T09:30:00Z\",\n \"balanceOptionAmountOvertakingStrategy\": \"balanceOptionAmountOvertakingStrategy\",\n \"balanceOptionCreditRounding\": \"balanceOptionCreditRounding\",\n \"balanceOptionDebitRounding\": \"balanceOptionDebitRounding\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"deletedAt\": \"deletedAt\",\n \"description\": \"description\",\n \"id\": \"id\",\n \"imageRef\": \"imageRef\",\n \"maxAmount\": 1.1,\n \"maxCreditAmountLimit\": 1.1,\n \"maxDebitAmountLimit\": 1.1,\n \"meta\": {\n \"key\": \"value\"\n },\n \"minAmount\": 1.1,\n \"name\": \"name\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1da76c71-d209-4641-9094-43a7214838ef", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a3817b26-f6c9-4900-86c4-6d4869b41b38", "name": "Delete balance definition - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a3817b26-f6c9-4900-86c4-6d4869b41b38", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3d2118a4-5218-46f1-8513-ef75d832d7d5", "name": "Create balance limits - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"constraintType\": \"constraintType\",\n \"createdAt\": \"createdAt\",\n \"durationUnit\": \"durationUnit\",\n \"durationValue\": 1,\n \"id\": \"id\",\n \"slidingSchedule\": true,\n \"transactionType\": \"transactionType\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3d2118a4-5218-46f1-8513-ef75d832d7d5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "5def443d-7ef0-4c5c-99d3-9e38a21ed142", "name": "Get balance limits - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" }, "blid": { "equalTo": "blid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"constraintType\": \"constraintType\",\n \"createdAt\": \"createdAt\",\n \"durationUnit\": \"durationUnit\",\n \"durationValue\": 1,\n \"id\": \"id\",\n \"slidingSchedule\": true,\n \"transactionType\": \"transactionType\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5def443d-7ef0-4c5c-99d3-9e38a21ed142", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3c24feb3-061c-4954-a12f-81100122b866", "name": "Updates balance limit - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}", "method": "PUT", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" }, "blid": { "equalTo": "blid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"constraintType\": \"constraintType\",\n \"createdAt\": \"createdAt\",\n \"durationUnit\": \"durationUnit\",\n \"durationValue\": 1,\n \"id\": \"id\",\n \"slidingSchedule\": true,\n \"transactionType\": \"transactionType\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3c24feb3-061c-4954-a12f-81100122b866", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "60e7789f-ecdc-4330-96f5-426c8865aa02", "name": "Delete balance limit - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" }, "bdid": { "equalTo": "bdid" }, "blid": { "equalTo": "blid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "60e7789f-ecdc-4330-96f5-426c8865aa02", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a00ea68f-14e1-4bbc-a3ad-1f4c555dbd92", "name": "Get balance list - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/contact-balances", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"balances\": [\n {\n \"contactId\": 1,\n \"loyaltySubscriptionId\": \"loyaltySubscriptionId\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1.1\n }\n ],\n \"count\": 1,\n \"loyaltyProgramId\": \"loyaltyProgramId\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a00ea68f-14e1-4bbc-a3ad-1f4c555dbd92", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "24af1e00-9fca-4515-89c5-bce7048b3f2e", "name": "Create balance order - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/create-order", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"amount\": 1.1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"dueAt\": \"dueAt\",\n \"expiresAt\": \"expiresAt\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"processedAt\": \"processedAt\",\n \"transactionid\": \"transactionid\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "24af1e00-9fca-4515-89c5-bce7048b3f2e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "bd77b0ff-3379-4930-aa93-f8cc25163bee", "name": "Get subscription balances - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/subscriptions/{cid}/balances", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "cid": { "equalTo": "cid" } } }, "response": { "status": 200, "body": "{\n \"balance\": [\n {\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"value\": 1.1\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "bd77b0ff-3379-4930-aa93-f8cc25163bee", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "06abbd3e-aec8-48f0-9c90-49887599e5ac", "name": "Create subscription balances - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/subscriptions/{cid}/balances", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "cid": { "equalTo": "cid" } } }, "response": { "status": 200, "body": "{\n \"amount\": 1.1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"consumedAt\": \"consumedAt\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"expiresAt\": \"expiresAt\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"organizationId\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "06abbd3e-aec8-48f0-9c90-49887599e5ac", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d806b377-c3f2-46e1-af10-826fc8cb7a77", "name": "Get Transaction History API - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/transaction-history", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"contactId\": 1,\n \"count\": 1,\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"transactionHistory\": [\n {\n \"amount\": 1.1,\n \"balanceExpirationDate\": \"balanceExpirationDate\",\n \"cancelledAt\": \"cancelledAt\",\n \"completedAt\": \"completedAt\",\n \"createdAt\": \"createdAt\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"rejectedAt\",\n \"status\": \"status\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d806b377-c3f2-46e1-af10-826fc8cb7a77", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "01dd65f2-fc30-4f9a-94e7-cf908b0c0b6a", "name": "Create new transaction - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/transactions", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"amount\": 1.1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"cancelledAt\": \"cancelledAt\",\n \"completedAt\": \"completedAt\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"eventTime\": \"eventTime\",\n \"expirationDate\": \"expirationDate\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"rejectedAt\",\n \"status\": \"status\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "01dd65f2-fc30-4f9a-94e7-cf908b0c0b6a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "bd42f484-63b7-431c-9d4b-a149ff9cd0b8", "name": "Cancel transaction - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/transactions/{tid}/cancel", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "{\n \"amount\": 1.1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"cancelledAt\": \"cancelledAt\",\n \"completedAt\": \"completedAt\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"eventTime\": \"eventTime\",\n \"expirationDate\": \"expirationDate\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"rejectedAt\",\n \"status\": \"status\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "bd42f484-63b7-431c-9d4b-a149ff9cd0b8", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fbed8bbf-cc97-48fb-a7f6-e56e37f2cf2e", "name": "Complete transaction - default", "request": { "urlPathTemplate": "/loyalty/balance/programs/{pid}/transactions/{tid}/complete", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "{\n \"amount\": 1.1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"cancelledAt\": \"cancelledAt\",\n \"completedAt\": \"completedAt\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"eventTime\": \"eventTime\",\n \"expirationDate\": \"expirationDate\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"rejectedAt\",\n \"status\": \"status\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fbed8bbf-cc97-48fb-a7f6-e56e37f2cf2e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "26205d6c-548c-4928-8845-8eb6528a066d", "name": "Get loyalty program list - default", "request": { "urlPathTemplate": "/loyalty/config/programs", "method": "GET" }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"codeCount\": 1,\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"documentId\": \"documentId\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"state\": \"inactive\",\n \"subscriptionGeneratorId\": \"subscriptionGeneratorId\",\n \"subscriptionPoolId\": \"subscriptionPoolId\",\n \"updatedAt\": \"updatedAt\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "26205d6c-548c-4928-8845-8eb6528a066d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "58d70d75-ea78-49d2-a9d6-beab3075e797", "name": "Create loyalty program - default", "request": { "urlPathTemplate": "/loyalty/config/programs", "method": "POST" }, "response": { "status": 200, "body": "{\n \"codeCount\": 1,\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"documentId\": \"documentId\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"state\": \"inactive\",\n \"subscriptionGeneratorId\": \"subscriptionGeneratorId\",\n \"subscriptionPoolId\": \"subscriptionPoolId\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "58d70d75-ea78-49d2-a9d6-beab3075e797", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c0fa09f4-d2b6-46f5-9560-abd8eb19c934", "name": "Get loyalty program Info - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"codeCount\": 1,\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"documentId\": \"documentId\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"state\": \"inactive\",\n \"subscriptionGeneratorId\": \"subscriptionGeneratorId\",\n \"subscriptionPoolId\": \"subscriptionPoolId\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c0fa09f4-d2b6-46f5-9560-abd8eb19c934", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "861e512a-8f3c-4e67-9519-b050d07984c6", "name": "Update loyalty program - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}", "method": "PUT", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"codeCount\": 1,\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"documentId\": \"documentId\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"state\": \"inactive\",\n \"subscriptionGeneratorId\": \"subscriptionGeneratorId\",\n \"subscriptionPoolId\": \"subscriptionPoolId\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "861e512a-8f3c-4e67-9519-b050d07984c6", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a87fbb4c-71e6-4806-9622-174c92be89d1", "name": "Delete Loyalty Program - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a87fbb4c-71e6-4806-9622-174c92be89d1", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "8a2689f4-70a0-4e02-8ce4-3c55e07bc708", "name": "Partially update loyalty program - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}", "method": "PATCH", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"codeCount\": 1,\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"documentId\": \"documentId\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"state\": \"inactive\",\n \"subscriptionGeneratorId\": \"subscriptionGeneratorId\",\n \"subscriptionPoolId\": \"subscriptionPoolId\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8a2689f4-70a0-4e02-8ce4-3c55e07bc708", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d32199cf-9ffa-4318-a330-2e9fda3da2d2", "name": "Get Subscription Data - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/account-info", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"balance\": {\n \"balances\": [\n {}\n ],\n \"contactId\": 1,\n \"loyaltyProgramId\": \"loyaltyProgramId\"\n },\n \"members\": [\n {\n \"createdAt\": \"createdAt\",\n \"memberContactId\": 1,\n \"updatedAt\": \"updatedAt\"\n }\n ],\n \"reward\": [\n {\n \"code\": \"code\",\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"expirationDate\": \"expirationDate\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rewardId\": \"rewardId\",\n \"updatedAt\": \"updatedAt\"\n }\n ],\n \"tier\": [\n {\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"groupId\": \"groupId\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"tierId\": \"tierId\",\n \"updatedAt\": \"updatedAt\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d32199cf-9ffa-4318-a330-2e9fda3da2d2", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0878ece4-9fe9-491a-9a7c-daaf7cf9c341", "name": "Delete subscription - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/contact/{cid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" }, "cid": { "equalTo": "1" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "0878ece4-9fe9-491a-9a7c-daaf7cf9c341", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e628ecea-6ac2-4237-bf4e-d3e911f50954", "name": "Publish loyalty program - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/publish", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "e628ecea-6ac2-4237-bf4e-d3e911f50954", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c63d1aae-db4f-4b4c-b82f-19e95683e037", "name": "Create subscription member - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/subscription-members", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"createdAt\",\n \"memberContactIds\": [\n 1\n ],\n \"organizationId\": 1,\n \"ownerContactId\": 1,\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c63d1aae-db4f-4b4c-b82f-19e95683e037", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "efc3a783-b09a-41eb-8c6f-6f3f03271ef4", "name": "Delete subscription member - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/subscription-members", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "efc3a783-b09a-41eb-8c6f-6f3f03271ef4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c73cc6cc-b51b-4e8a-ae72-3446029b9ec5", "name": "Create subscription - default", "request": { "urlPathTemplate": "/loyalty/config/programs/{pid}/subscriptions", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"contactId\": 1,\n \"createdAt\": \"createdAt\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"loyaltySubscriptionId\": \"loyaltySubscriptionId\",\n \"organizationId\": 1,\n \"updatedAt\": \"updatedAt\",\n \"versionId\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c73cc6cc-b51b-4e8a-ae72-3446029b9ec5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "da280697-1454-4e11-996a-89c499cf8d7f", "name": "Get code count - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/code-pools/{cpid}/codes-count", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "cpid": { "equalTo": "cpid" } } }, "response": { "status": 200, "body": "{\n \"count\": 1000000\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "da280697-1454-4e11-996a-89c499cf8d7f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3d324fa9-3782-4213-ab50-8574dc117f03", "name": "Get Reward Page API - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/offers", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"endDate\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"publicImage\": \"publicImage\",\n \"startDate\": \"2024-01-15T09:30:00Z\",\n \"state\": \"state\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"totalCount\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3d324fa9-3782-4213-ab50-8574dc117f03", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e24ddc18-7dbb-4302-828c-d6e53ebb4a34", "name": "Create a reward - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/offers", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"publicDescription\": \"publicDescription\",\n \"publicImage\": \"publicImage\",\n \"publicName\": \"publicName\",\n \"updatedAt\": \"updatedAt\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e24ddc18-7dbb-4302-828c-d6e53ebb4a34", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "661c8611-a50c-4e77-aad2-b152b4a15e63", "name": "Create a voucher - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/attribute", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"code\": \"code\",\n \"consumedAt\": \"consumedAt\",\n \"contactId\": 1000000,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"expirationDate\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rewardId\": \"rewardId\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\",\n \"value\": 1.1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "661c8611-a50c-4e77-aad2-b152b4a15e63", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "aa8692b0-126d-488d-b643-8fe0de2f8405", "name": "Create redeem voucher request - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/redeem", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"cancelledAt\": \"2024-01-15T09:30:00Z\",\n \"completedAt\": \"2024-01-15T09:30:00Z\",\n \"contactId\": 1000000,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"debitTransactionId\": \"debitTransactionId\",\n \"expiresAt\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"2024-01-15T09:30:00Z\",\n \"rewardAttributionId\": \"rewardAttributionId\",\n \"status\": \"status\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "aa8692b0-126d-488d-b643-8fe0de2f8405", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "99e6b97f-e193-4c85-b833-07efab4f9b5b", "name": "Complete redeem voucher request - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/redeem/{tid}/complete", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "{\n \"cancelledAt\": \"2024-01-15T09:30:00Z\",\n \"completedAt\": \"2024-01-15T09:30:00Z\",\n \"contactId\": 1000000,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"debitTransactionId\": \"debitTransactionId\",\n \"expiresAt\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rejectReason\": \"rejectReason\",\n \"rejectedAt\": \"2024-01-15T09:30:00Z\",\n \"rewardAttributionId\": \"rewardAttributionId\",\n \"status\": \"status\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "99e6b97f-e193-4c85-b833-07efab4f9b5b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "919890cf-9d52-46fe-87bc-03565bdc4697", "name": "Revoke vouchers - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/revoke", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "919890cf-9d52-46fe-87bc-03565bdc4697", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "53d2fcd5-6b39-4fa3-a257-21f60d24efc5", "name": "Validate a reward - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/validate", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"authorize\": true\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "53d2fcd5-6b39-4fa3-a257-21f60d24efc5", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "66e13a60-2e6c-4f3b-9ff7-fc1cdcc147b8", "name": "Get reward information - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/rewards/{rid}", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "rid": { "equalTo": "rid" } } }, "response": { "status": 200, "body": "{\n \"attributionPerConsumer\": 1,\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"code\": \"code\",\n \"codeCount\": 1000000,\n \"codeGeneratorId\": \"codeGeneratorId\",\n \"codePoolId\": \"codePoolId\",\n \"config\": \"config\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"disabledAt\": \"2024-01-15T09:30:00Z\",\n \"endDate\": \"2024-01-15T09:30:00Z\",\n \"expirationDate\": \"2024-01-15T09:30:00Z\",\n \"expirationModifier\": \"startOfPeriod\",\n \"expirationUnit\": \"expirationUnit\",\n \"expirationValue\": 1,\n \"generator\": {\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"id\": \"id\",\n \"name\": \"name\",\n \"pattern\": \"pattern\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n },\n \"id\": \"id\",\n \"limits\": [\n {\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"durationUnit\": \"durationUnit\",\n \"durationValue\": 1,\n \"limitValue\": 1,\n \"rewardLimitId\": \"rewardLimitId\",\n \"slidingSchedule\": true,\n \"type\": \"type\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"products\": [\n {\n \"createdAt\": \"createdAt\",\n \"imageRef\": \"imageRef\",\n \"productId\": \"productId\",\n \"value\": \"value\"\n }\n ],\n \"publicDescription\": \"publicDescription\",\n \"publicImage\": \"publicImage\",\n \"publicName\": \"publicName\",\n \"redeemPerConsumer\": 1,\n \"redeemRules\": [\n \"redeemRules\"\n ],\n \"rewardConfigs\": {\n \"attribution\": \"attribution\",\n \"code\": \"code\",\n \"value\": \"value\"\n },\n \"rule\": {\n \"condition\": {\n \"op\": \"op\"\n },\n \"createdAt\": \"createdAt\",\n \"description\": \"description\",\n \"event\": {\n \"name\": \"name\",\n \"source\": \"source\"\n },\n \"isInternal\": true,\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"loyaltyVersionId\": 1,\n \"meta\": {\n \"key\": \"value\"\n },\n \"name\": \"name\",\n \"results\": [\n {}\n ],\n \"ruleId\": \"ruleId\",\n \"ruleType\": \"ruleType\",\n \"updatedAt\": \"updatedAt\"\n },\n \"startDate\": \"2024-01-15T09:30:00Z\",\n \"subtractBalanceDefinitionId\": \"subtractBalanceDefinitionId\",\n \"subtractBalanceStrategy\": \"subtractBalanceStrategy\",\n \"subtractBalanceValue\": 1,\n \"subtractTotalBalance\": true,\n \"totalAttribution\": 1,\n \"totalRedeem\": 1,\n \"triggerId\": \"triggerId\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1.1,\n \"valueType\": \"valueType\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "66e13a60-2e6c-4f3b-9ff7-fc1cdcc147b8", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "950e340e-ab9c-42c4-8c85-9ea1bd43113d", "name": "Get voucher for a contact - default", "request": { "urlPathTemplate": "/loyalty/offer/programs/{pid}/vouchers", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"contactId\": 1000000,\n \"contactRewards\": [\n {\n \"code\": \"code\",\n \"consumedAt\": \"consumedAt\",\n \"createdAt\": \"createdAt\",\n \"expirationDate\": \"expirationDate\",\n \"id\": \"id\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"rewardId\": \"rewardId\",\n \"unit\": \"unit\",\n \"updatedAt\": \"updatedAt\",\n \"value\": 1.1\n }\n ],\n \"count\": 1,\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"loyaltySubscriptionId\": \"loyaltySubscriptionId\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "950e340e-ab9c-42c4-8c85-9ea1bd43113d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f3e1d26e-fbde-4b7e-afe4-fabb4960ff71", "name": "Assign a tier - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid}", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "cid": { "equalTo": "cid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "{\n \"contactId\": 1,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"groupId\": \"groupId\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "f3e1d26e-fbde-4b7e-afe4-fabb4960ff71", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e6fc762d-7440-4454-beb1-ff71f4a9080e", "name": "List tier groups - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"downgradeStrategy\": \"real_time\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierOrder\": [\n \"tierOrder\"\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\",\n \"upgradeStrategy\": \"real_time\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e6fc762d-7440-4454-beb1-ff71f4a9080e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d33f2b3b-2dd3-4911-8200-e4b4ef965933", "name": "Create a tier group - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"downgradeStrategy\": \"real_time\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierOrder\": [\n \"tierOrder\"\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\",\n \"upgradeStrategy\": \"real_time\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d33f2b3b-2dd3-4911-8200-e4b4ef965933", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "562fecbb-8cc8-46ae-b519-3fd2825bb107", "name": "Get tier group - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups/{gid}", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" }, "gid": { "equalTo": "gid" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"downgradeStrategy\": \"real_time\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierOrder\": [\n \"tierOrder\"\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\",\n \"upgradeStrategy\": \"real_time\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "562fecbb-8cc8-46ae-b519-3fd2825bb107", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "67f29817-d31a-4186-b787-9277e465e139", "name": "Update tier group - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups/{gid}", "method": "PUT", "pathParameters": { "pid": { "equalTo": "pid" }, "gid": { "equalTo": "gid" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"downgradeStrategy\": \"real_time\",\n \"id\": \"id\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierOrder\": [\n \"tierOrder\"\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\",\n \"upgradeStrategy\": \"real_time\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "67f29817-d31a-4186-b787-9277e465e139", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a9e14ece-a957-40e8-b723-4b89904599dd", "name": "Delete tier group - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups/{gid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" }, "gid": { "equalTo": "gid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a9e14ece-a957-40e8-b723-4b89904599dd", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d2b435bf-764a-46a6-a860-04672e2611c0", "name": "Create a tier - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers", "method": "POST", "pathParameters": { "pid": { "equalTo": "pid" }, "gid": { "equalTo": "gid" } } }, "response": { "status": 200, "body": "{\n \"accessConditions\": [\n {\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"minimumValue\": 1,\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"groupId\": \"groupId\",\n \"imageRef\": \"imageRef\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierId\": \"tierId\",\n \"tierRewards\": [\n {\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"rewardId\": \"rewardId\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "d2b435bf-764a-46a6-a860-04672e2611c0", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e335b644-b3a8-4e92-9222-a80f9a8dd3ab", "name": "List tiers - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tiers", "method": "GET", "pathParameters": { "pid": { "equalTo": "pid" } } }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"accessConditions\": [\n {}\n ],\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"groupId\": \"groupId\",\n \"imageRef\": \"imageRef\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierId\": \"tierId\",\n \"tierRewards\": [\n {}\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e335b644-b3a8-4e92-9222-a80f9a8dd3ab", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "c299567a-50ff-4db3-a919-280c95c9de65", "name": "Update tier - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tiers/{tid}", "method": "PUT", "pathParameters": { "pid": { "equalTo": "pid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "{\n \"accessConditions\": [\n {\n \"balanceDefinitionId\": \"balanceDefinitionId\",\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"minimumValue\": 1,\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"groupId\": \"groupId\",\n \"imageRef\": \"imageRef\",\n \"loyaltyProgramId\": \"loyaltyProgramId\",\n \"name\": \"name\",\n \"tierId\": \"tierId\",\n \"tierRewards\": [\n {\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"rewardId\": \"rewardId\",\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"updatedAt\": \"2024-01-15T09:30:00Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "c299567a-50ff-4db3-a919-280c95c9de65", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "05e6afcc-fb74-4457-a108-1dc6a10a5be7", "name": "Delete tier - default", "request": { "urlPathTemplate": "/loyalty/tier/programs/{pid}/tiers/{tid}", "method": "DELETE", "pathParameters": { "pid": { "equalTo": "pid" }, "tid": { "equalTo": "tid" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "05e6afcc-fb74-4457-a108-1dc6a10a5be7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "cec8c14d-adf6-497f-95ee-c48ab1d6503d", "name": "Return all your created email campaigns - default", "request": { "urlPathTemplate": "/emailCampaigns", "method": "GET" }, "response": { "status": 200, "body": "{\n \"campaigns\": [\n {\n \"abTesting\": true,\n \"id\": 12,\n \"name\": \"EN - Sales Summer 2017\",\n \"previewText\": \"Don't miss the sale!\",\n \"scheduledAt\": \"2017-06-01T12:30:00Z\",\n \"sendAtBestTime\": true,\n \"splitRule\": 25,\n \"status\": \"sent\",\n \"subject\": \"20% OFF for 2017 Summer Sales\",\n \"subjectA\": \"Discover the New Collection!\",\n \"subjectB\": \"Want to discover the New Collection?\",\n \"type\": \"classic\",\n \"winnerCriteria\": \"open\",\n \"winnerDelay\": 50,\n \"createdAt\": \"2017-05-01T12:30:00Z\",\n \"footer\": \"[DEFAULT_FOOTER]\",\n \"header\": \"[DEFAULT_HEADER]\",\n \"htmlContent\": \"This is my HTML Content\",\n \"inlineImageActivation\": true,\n \"mirrorActive\": true,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"recurring\": false,\n \"replyTo\": \"replyto@domain.com\",\n \"returnBounce\": 5,\n \"sender\": {\n \"email\": \"marketing@mycompany.com\",\n \"id\": 26,\n \"name\": \"Marketing\"\n },\n \"sentDate\": \"2018-12-01T16:30:00Z\",\n \"shareLink\": \"http://example.com/fhsgccc.html?t=9865448900\",\n \"tag\": \"Newsletter\",\n \"testSent\": true,\n \"toField\": \"{FNAME} {LNAME}\",\n \"utmCampaignValue\": \"myutm\",\n \"utmIDActive\": true,\n \"utmMedium\": \"EMAIL\",\n \"utmSource\": \"Brevo\",\n \"recipients\": {\n \"exclusionLists\": [\n 13\n ],\n \"lists\": [\n 5\n ]\n },\n \"statistics\": {\n \"campaignStats\": [\n {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 5,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n }\n ],\n \"globalStats\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n },\n \"linksStats\": {},\n \"mirrorClick\": 120,\n \"remaining\": 1000,\n \"statsByBrowser\": {\n \"key\": {\n \"clickers\": 2665,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"viewed\": 8999\n }\n },\n \"statsByDevice\": {},\n \"statsByDomain\": {\n \"hotmail.co.uk\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2720,\n \"complaints\": 5,\n \"deferred\": 30,\n \"delivered\": 117056,\n \"estimatedViews\": 560,\n \"hardBounces\": 0,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 117055,\n \"softBounces\": 111,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 1970,\n \"uniqueViews\": 21111,\n \"unsubscriptions\": 105,\n \"viewed\": 35251\n },\n \"yahoo.com\": {\n \"appleMppOpens\": 10,\n \"clickers\": 533,\n \"complaints\": 0,\n \"deferred\": 30,\n \"delivered\": 25596,\n \"estimatedViews\": 560,\n \"hardBounces\": 0,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 25601,\n \"softBounces\": 5,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 298,\n \"uniqueViews\": 3527,\n \"unsubscriptions\": 17,\n \"viewed\": 5255\n }\n }\n }\n },\n {\n \"abTesting\": true,\n \"id\": 22,\n \"name\": \"Weekly - 1\",\n \"previewText\": \"your weekly newsletter!\",\n \"scheduledAt\": \"\",\n \"sendAtBestTime\": true,\n \"splitRule\": 25,\n \"status\": \"draft\",\n \"subject\": \"Week 1 - Newsletter\",\n \"subjectA\": \"Discover the New Collection!\",\n \"subjectB\": \"Want to discover the New Collection?\",\n \"type\": \"classic\",\n \"winnerCriteria\": \"open\",\n \"winnerDelay\": 50,\n \"createdAt\": \"2017-05-01T12:30:00Z\",\n \"footer\": \"[DEFAULT_FOOTER]\",\n \"header\": \"[DEFAULT_HEADER]\",\n \"htmlContent\": \"This is my HTML Content\",\n \"inlineImageActivation\": true,\n \"mirrorActive\": true,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"recurring\": false,\n \"replyTo\": \"replyto@domain.com\",\n \"returnBounce\": 5,\n \"sender\": {\n \"email\": \"newsletter@mycompany.com\",\n \"id\": 26,\n \"name\": \"Newsletter\"\n },\n \"sentDate\": \"2018-12-01T16:30:00Z\",\n \"shareLink\": \"http://example.com/fhsgccc.html?t=9865448900\",\n \"tag\": \"Newsletter\",\n \"testSent\": false,\n \"toField\": \"{FNAME} {LNAME}\",\n \"utmCampaignValue\": \"myutm\",\n \"utmIDActive\": true,\n \"utmMedium\": \"EMAIL\",\n \"utmSource\": \"Brevo\",\n \"recipients\": {\n \"exclusionLists\": [\n 45\n ],\n \"lists\": [\n 10\n ]\n },\n \"statistics\": {\n \"campaignStats\": [\n {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 10,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n }\n ],\n \"globalStats\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 29.42,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n },\n \"linksStats\": {},\n \"mirrorClick\": 120,\n \"remaining\": 1000,\n \"statsByBrowser\": {\n \"key\": {\n \"clickers\": 2665,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"viewed\": 8999\n }\n },\n \"statsByDevice\": {},\n \"statsByDomain\": {\n \"aol\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n },\n \"gmail\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n }\n }\n }\n }\n ],\n \"count\": 2\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "cec8c14d-adf6-497f-95ee-c48ab1d6503d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "3d7c577e-d169-438f-b91c-d1f90d441dee", "name": "Create an email campaign - default", "request": { "urlPathTemplate": "/emailCampaigns", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3d7c577e-d169-438f-b91c-d1f90d441dee", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b6e00948-fca2-4a11-addd-d16045c94c90", "name": "Upload an image to your account's image gallery - default", "request": { "urlPathTemplate": "/emailCampaigns/images", "method": "POST" }, "response": { "status": 201, "body": "{\n \"url\": \"https://img.mailinblue.com/100000/images/rnb/original/62casdase8wewq9df1c2f27c.jpeg\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "b6e00948-fca2-4a11-addd-d16045c94c90", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "da8f0483-4951-4e2d-a495-15906071e018", "name": "Get an email campaign report - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}", "method": "GET", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"abTesting\": true,\n \"id\": 22,\n \"name\": \"Weekly - 1\",\n \"previewText\": \"your weekly newsletter\",\n \"scheduledAt\": \"2017-09-22T12:30:00Z\",\n \"sendAtBestTime\": true,\n \"splitRule\": 25,\n \"status\": \"draft\",\n \"subject\": \"Week 1 - Newsletter\",\n \"subjectA\": \"Discover the New Collection!\",\n \"subjectB\": \"Want to discover the New Collection?\",\n \"type\": \"classic\",\n \"winnerCriteria\": \"open\",\n \"winnerDelay\": 50,\n \"createdAt\": \"2017-05-01T12:30:00Z\",\n \"footer\": \"[DEFAULT_FOOTER]\",\n \"header\": \"[DEFAULT_HEADER]\",\n \"htmlContent\": \"This is my HTML Content\",\n \"inlineImageActivation\": true,\n \"mirrorActive\": true,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"recurring\": false,\n \"replyTo\": \"replyto@domain.com\",\n \"returnBounce\": 5,\n \"sender\": {\n \"email\": \"newsletter@mycompany.com\",\n \"id\": 26,\n \"name\": \"Newsletter\"\n },\n \"sentDate\": \"2018-12-01T16:30:00Z\",\n \"shareLink\": \"http://dhh.brevo.com/fhsgccc.html?t=9865448900\",\n \"tag\": \"Newsletter\",\n \"testSent\": false,\n \"toField\": \"{FNAME} {LNAME}\",\n \"utmCampaignValue\": \"myutm\",\n \"utmIDActive\": true,\n \"utmMedium\": \"EMAIL\",\n \"utmSource\": \"Brevo\",\n \"recipients\": {\n \"exclusionLists\": [\n 45\n ],\n \"lists\": [\n 22\n ]\n },\n \"statistics\": {\n \"campaignStats\": [\n {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 22,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n }\n ],\n \"globalStats\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 24.59,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n },\n \"linksStats\": {},\n \"mirrorClick\": 120,\n \"remaining\": 1000,\n \"statsByBrowser\": {\n \"internetExplorer\": {\n \"clickers\": 0,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 0,\n \"viewed\": 1\n },\n \"safari\": {\n \"clickers\": 1,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 0,\n \"viewed\": 1\n },\n \"thunderbird\": {\n \"clickers\": 1,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 0,\n \"viewed\": 1\n }\n },\n \"statsByDevice\": {\n \"desktop\": {\n \"mac\": {\n \"clickers\": 1,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 1,\n \"viewed\": 2\n }\n },\n \"mobile\": {\n \"androidMobile\": {\n \"clickers\": 1,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 0,\n \"viewed\": 1\n },\n \"iPhone\": {\n \"clickers\": 1,\n \"uniqueClicks\": 0,\n \"uniqueViews\": 0,\n \"viewed\": 2\n }\n },\n \"tablet\": {\n \"key\": {\n \"clickers\": 2665,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"viewed\": 8999\n }\n },\n \"unknown\": {\n \"key\": {\n \"clickers\": 2665,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"viewed\": 8999\n }\n }\n },\n \"statsByDomain\": {\n \"gmail\": {\n \"appleMppOpens\": 10,\n \"clickers\": 2665,\n \"complaints\": 1,\n \"deferred\": 30,\n \"delivered\": 19765,\n \"estimatedViews\": 560,\n \"hardBounces\": 87,\n \"listId\": 2,\n \"opensRate\": 29.54,\n \"returnBounce\": 5,\n \"sent\": 19887,\n \"softBounces\": 100,\n \"trackableViews\": 5661,\n \"trackableViewsRate\": 23.45,\n \"uniqueClicks\": 2300,\n \"uniqueViews\": 7779,\n \"unsubscriptions\": 2,\n \"viewed\": 8999\n }\n }\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "da8f0483-4951-4e2d-a495-15906071e018", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "27d7a953-713c-4dcc-a03d-a5fcd5fbc134", "name": "Update an email campaign - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}", "method": "PUT", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "27d7a953-713c-4dcc-a03d-a5fcd5fbc134", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "28dbcc0e-eed7-4b02-a7d8-2aab0a25c731", "name": "Delete an email campaign - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}", "method": "DELETE", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "28dbcc0e-eed7-4b02-a7d8-2aab0a25c731", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "969348eb-29d3-48ab-82d1-c46a8412178e", "name": "Get an A/B test email campaign results - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/abTestCampaignResult", "method": "GET", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"clickRate\": \"50%\",\n \"clickedLinks\": {\n \"Version A\": [\n {\n \"clickRate\": \"0%\",\n \"clicksCount\": 0,\n \"link\": \"https://google.com\"\n },\n {\n \"clickRate\": \"0%\",\n \"clicksCount\": 0,\n \"link\": \"https://youtube.com\"\n }\n ],\n \"Version B\": [\n {\n \"clickRate\": \"40%\",\n \"clicksCount\": 2,\n \"link\": \"http://www.github.com\"\n },\n {\n \"clickRate\": \"60%\",\n \"clicksCount\": 3,\n \"link\": \"http://www.stackoverflow.com\"\n }\n ]\n },\n \"openRate\": \"100%\",\n \"statistics\": {\n \"clicks\": {\n \"Version A\": \"0%\",\n \"Version B\": \"50%\"\n },\n \"complaints\": {\n \"Version A\": \"0%\",\n \"Version B\": \"0%\"\n },\n \"hardBounces\": {\n \"Version A\": \"0%\",\n \"Version B\": \"0%\"\n },\n \"openers\": {\n \"Version A\": \"20%\",\n \"Version B\": \"100%\"\n },\n \"softBounces\": {\n \"Version A\": \"0%\",\n \"Version B\": \"0%\"\n },\n \"unsubscribed\": {\n \"Version A\": \"20%\",\n \"Version B\": \"0%\"\n }\n },\n \"winningCriteria\": \"Click\",\n \"winningSubjectLine\": \"Subject Line A\",\n \"winningVersion\": \"B\",\n \"winningVersionRate\": \"0%\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "969348eb-29d3-48ab-82d1-c46a8412178e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "93e3be61-a737-4896-a697-7417b837b571", "name": "Export the recipients of an email campaign - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/exportRecipients", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 202, "body": "{\n \"processId\": 78\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "93e3be61-a737-4896-a697-7417b837b571", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b0b17959-d743-449c-8bdd-ab28a42870cc", "name": "Send an email campaign immediately, based on campaignId - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/sendNow", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "b0b17959-d743-449c-8bdd-ab28a42870cc", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "57eba48c-9a52-4e90-a12c-fa89a469f035", "name": "Send the report of a campaign - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/sendReport", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "57eba48c-9a52-4e90-a12c-fa89a469f035", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fc668b8b-10da-4f83-ae38-5004f0a64ae7", "name": "Send an email campaign to your test list - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/sendTest", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "fc668b8b-10da-4f83-ae38-5004f0a64ae7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6bc6114e-fc20-4aa2-ba22-7e7fe7f95244", "name": "Get a shared template url - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/sharedUrl", "method": "GET", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"sharedUrl\": \"https://my.brevo.com/pt2YU7R5W_guXlowgumy_VX4pFsKu._zd0Gjj96x1_GMmzc1Qps5ZIpj6nx-\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6bc6114e-fc20-4aa2-ba22-7e7fe7f95244", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "8d661344-163b-4798-a243-ba10bd08cbe9", "name": "Update an email campaign status - default", "request": { "urlPathTemplate": "/emailCampaigns/{campaignId}/status", "method": "PUT", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "8d661344-163b-4798-a243-ba10bd08cbe9", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ffedd57d-0198-49a4-9112-ce7ae8751ebc", "name": "Returns the information for all your created SMS campaigns - default", "request": { "urlPathTemplate": "/smsCampaigns", "method": "GET" }, "response": { "status": 200, "body": "{\n \"campaigns\": [\n {\n \"content\": \"Visit our Store and get some discount !\",\n \"createdAt\": \"2017-06-01T12:30:00Z\",\n \"id\": 2,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"name\": \"PROMO CODE\",\n \"scheduledAt\": \"2017-06-01T12:30:00Z\",\n \"sender\": \"MyCompany\",\n \"status\": \"sent\",\n \"recipients\": {\n \"exclusionLists\": [\n 13\n ],\n \"lists\": [\n 21\n ]\n },\n \"statistics\": {\n \"answered\": 2,\n \"delivered\": 2987,\n \"hardBounces\": 1,\n \"processing\": 0,\n \"sent\": 3000,\n \"softBounces\": 3,\n \"unsubscriptions\": 3\n }\n },\n {\n \"content\": \"Summer Sale is starting tomorrow. Get extra 10% with this code:SUM17\",\n \"createdAt\": \"2017-06-01T12:30:00Z\",\n \"id\": 10,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"name\": \"SUMMER SALE\",\n \"scheduledAt\": \"2017-08-04T12:30:00Z\",\n \"sender\": \"MyCompany\",\n \"status\": \"draft\",\n \"recipients\": {\n \"exclusionLists\": [\n 13\n ],\n \"lists\": [\n 21\n ]\n },\n \"statistics\": {\n \"answered\": 2,\n \"delivered\": 2987,\n \"hardBounces\": 1,\n \"processing\": 0,\n \"sent\": 3000,\n \"softBounces\": 3,\n \"unsubscriptions\": 3\n }\n }\n ],\n \"count\": 12\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ffedd57d-0198-49a4-9112-ce7ae8751ebc", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "ff5b73cc-83d1-4d1c-9038-f01bc11a604e", "name": "Creates an SMS campaign - default", "request": { "urlPathTemplate": "/smsCampaigns", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ff5b73cc-83d1-4d1c-9038-f01bc11a604e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "9ff5c02a-8b74-486b-aca9-7ac003b1838c", "name": "Get an SMS campaign - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}", "method": "GET", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"content\": \"Visit our Store and get some discount !\",\n \"createdAt\": \"2017-06-01T12:30:00Z\",\n \"id\": 2,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"name\": \"PROMO CODE\",\n \"scheduledAt\": \"2017-06-01T12:30:00Z\",\n \"sender\": \"MyCompany\",\n \"status\": \"sent\",\n \"recipients\": {\n \"exclusionLists\": [\n 13\n ],\n \"lists\": [\n 21\n ]\n },\n \"statistics\": {\n \"answered\": 2,\n \"delivered\": 2987,\n \"hardBounces\": 1,\n \"processing\": 0,\n \"sent\": 3000,\n \"softBounces\": 3,\n \"unsubscriptions\": 3\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "9ff5c02a-8b74-486b-aca9-7ac003b1838c", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "828e0b76-55ec-4b20-83fd-ff0d9c6a807f", "name": "Update an SMS campaign - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}", "method": "PUT", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "828e0b76-55ec-4b20-83fd-ff0d9c6a807f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0938f276-c211-4150-91ac-9ea5e3ddf7fe", "name": "Delete an SMS campaign - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}", "method": "DELETE", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "0938f276-c211-4150-91ac-9ea5e3ddf7fe", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "daaeea82-c583-43fb-b4c7-a6bbc940fc47", "name": "Export an SMS campaign's recipients - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}/exportRecipients", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 202, "body": "{\n \"processId\": 78\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "daaeea82-c583-43fb-b4c7-a6bbc940fc47", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b7dd5175-f7a0-4b5e-9224-203d4fae1c4d", "name": "Send your SMS campaign immediately - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}/sendNow", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "b7dd5175-f7a0-4b5e-9224-203d4fae1c4d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "64e8bd39-5b33-477a-ae7f-0501cb5a6140", "name": "Send an SMS campaign's report - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}/sendReport", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "64e8bd39-5b33-477a-ae7f-0501cb5a6140", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "734d1bda-9010-4188-9a00-57d5b302eee4", "name": "Send a test SMS campaign - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}/sendTest", "method": "POST", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "734d1bda-9010-4188-9a00-57d5b302eee4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "694adffd-8af9-45be-8225-5e44e17d7454", "name": "Update a campaign's status - default", "request": { "urlPathTemplate": "/smsCampaigns/{campaignId}/status", "method": "PUT", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "694adffd-8af9-45be-8225-5e44e17d7454", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "03183785-7a99-4733-896c-eb489047065c", "name": "Return all your created WhatsApp campaigns - default", "request": { "urlPathTemplate": "/whatsappCampaigns", "method": "GET" }, "response": { "status": 200, "body": "{\n \"campaigns\": [\n {\n \"campaignName\": \"campaign_22\",\n \"campaignStatus\": \"sent\",\n \"createdAt\": \"2017-05-01T12:30:00Z\",\n \"errorReason\": \"NONE\",\n \"id\": 1672035851100690,\n \"invalidatedContacts\": 0,\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"readPercentage\": 28.57,\n \"scheduledAt\": \"2022-12-27T09:50:00Z\",\n \"stats\": {\n \"delivered\": 3,\n \"notSent\": 4,\n \"read\": 2,\n \"sent\": 3,\n \"unsubscribe\": 0\n },\n \"templateId\": \"templateId\"\n }\n ],\n \"count\": 23\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "03183785-7a99-4733-896c-eb489047065c", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "5fc3f144-a51f-454f-a5d0-019b38ba3c15", "name": "Create and Send a WhatsApp campaign - default", "request": { "urlPathTemplate": "/whatsappCampaigns", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5fc3f144-a51f-454f-a5d0-019b38ba3c15", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "cc80c9bc-ff82-4140-9b7a-dfb84c8e99a7", "name": "Get your WhatsApp API account information - default", "request": { "urlPathTemplate": "/whatsappCampaigns/config", "method": "GET" }, "response": { "status": 200, "body": "{\n \"businessStatus\": \"verified\",\n \"phoneNumberNameStatus\": \"APPROVED\",\n \"phoneNumberQuality\": \"GREEN\",\n \"sendingLimit\": \"TIER_1K\",\n \"whatsappBusinessAccountId\": \"whatsappBusinessAccountId\",\n \"whatsappBusinessAccountStatus\": \"APPROVED\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "cc80c9bc-ff82-4140-9b7a-dfb84c8e99a7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "5217f5cb-e270-45d2-bf41-0aa3651c5839", "name": "Create a WhatsApp template - default", "request": { "urlPathTemplate": "/whatsappCampaigns/template", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "5217f5cb-e270-45d2-bf41-0aa3651c5839", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e541402c-10e0-447d-ab89-e9102a312296", "name": "Return all your created WhatsApp templates - default", "request": { "urlPathTemplate": "/whatsappCampaigns/template-list", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"templates\": [\n {\n \"category\": \"MARKETING\",\n \"createdAt\": \"2017-05-01T12:30:00Z\",\n \"errorReason\": \"NONE\",\n \"id\": 235,\n \"language\": \"en\",\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"name\": \"campaign_22\",\n \"status\": \"approved\"\n },\n {\n \"category\": \"MARKETING\",\n \"createdAt\": \"2017-0\",\n \"errorReason\": \"NONE\",\n \"id\": 124,\n \"language\": \"\",\n \"modifiedAt\": \"2017-05-01T12:30:00Z\",\n \"name\": \"test-template\",\n \"status\": \"draft\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e541402c-10e0-447d-ab89-e9102a312296", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "c47467e5-3355-486f-b83b-ecf963b249b4", "name": "Send your WhatsApp template for approval - default", "request": { "urlPathTemplate": "/whatsappCampaigns/template/approval/{templateId}", "method": "POST", "pathParameters": { "templateId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "c47467e5-3355-486f-b83b-ecf963b249b4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "6d437255-9beb-48aa-9616-0b438eb437f6", "name": "Get a WhatsApp campaign - default", "request": { "urlPathTemplate": "/whatsappCampaigns/{campaignId}", "method": "GET", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"campaignName\": \"Test WhatsApp Campaign\",\n \"campaignStatus\": \"sent\",\n \"createdAt\": \"2022-12-26T06:50:00Z\",\n \"id\": 1672035851100690,\n \"modifiedAt\": \"2022-12-26T08:50:00Z\",\n \"scheduledAt\": \"2022-12-27T09:50:00Z\",\n \"senderNumber\": \"senderNumber\",\n \"stats\": {\n \"delivered\": 3,\n \"notSent\": 4,\n \"read\": 2,\n \"sent\": 3,\n \"unsubscribe\": 0\n },\n \"template\": {\n \"body_variables\": [\n {\n \"datatype\": \"text\",\n \"default\": \"INVALID_HEADER\",\n \"name\": \"FIRSTNAME\"\n }\n ],\n \"button_type\": \"CALL_TO_ACTION\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"text\": \"making it look like readable English.\",\n \"type\": \"BODY\"\n },\n {\n \"text\": \"Life is a long lesson in humility\",\n \"type\": \"BUTTONS\"\n }\n ],\n \"contains_button\": true,\n \"display_header\": false,\n \"header_type\": \"text\",\n \"header_variables\": [\n {\n \"datatype\": \"text\",\n \"default\": \"INVALID HEADER\",\n \"name\": \"FIRSTNAME\"\n }\n ],\n \"hide_footer\": true,\n \"language\": \"en\",\n \"name\": \"official_campaign8\"\n }\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "6d437255-9beb-48aa-9616-0b438eb437f6", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "eb75a9a4-36c5-4126-9a14-85044f19f2c1", "name": "Update a WhatsApp campaign - default", "request": { "urlPathTemplate": "/whatsappCampaigns/{campaignId}", "method": "PUT", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "eb75a9a4-36c5-4126-9a14-85044f19f2c1", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b4ef121d-89fa-4fb6-984d-39467bf9fd6b", "name": "Delete a WhatsApp campaign - default", "request": { "urlPathTemplate": "/whatsappCampaigns/{campaignId}", "method": "DELETE", "pathParameters": { "campaignId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "b4ef121d-89fa-4fb6-984d-39467bf9fd6b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "eb31fc6b-22fd-431f-ba7e-59e0d7773487", "name": "Get all Companies - default", "request": { "urlPathTemplate": "/companies", "method": "GET" }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"attributes\": {\n \"created_at\": \"2022-01-13T19:04:24.376+05:30\",\n \"domain\": \"xyz\",\n \"last_updated_at\": \"2022-04-01T18:47:48.283+05:30\",\n \"name\": \"text\",\n \"number_of_contacts\": 0,\n \"owner\": \"62260474111b1101704a9d85\",\n \"owner_assign_date\": \"2022-04-01T18:21:13.379+05:30\",\n \"phone_number\": 8171844192,\n \"revenue\": 10\n },\n \"id\": \"629475917295261d9b1f4403\",\n \"linkedContactsIds\": [\n 1,\n 2,\n 3\n ],\n \"linkedDealsIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ]\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "eb31fc6b-22fd-431f-ba7e-59e0d7773487", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "e17f5536-5a6b-4a26-8102-3170dd47ae3d", "name": "Create a company - default", "request": { "urlPathTemplate": "/companies", "method": "POST" }, "response": { "status": 200, "body": "{\n \"id\": \"61a5cd07ca1347c82306ad06\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "e17f5536-5a6b-4a26-8102-3170dd47ae3d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f390d3a7-6a70-4b45-ad33-f4f3d3000538", "name": "Import companies(creation and updation) - default", "request": { "urlPathTemplate": "/companies/import", "method": "POST" }, "response": { "status": 200, "body": "{\n \"processId\": 50\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "f390d3a7-6a70-4b45-ad33-f4f3d3000538", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "708feaed-27c0-429f-8086-5e7c5e4ecd8d", "name": "Link and Unlink company with contact and deal - default", "request": { "urlPathTemplate": "/companies/link-unlink/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "708feaed-27c0-429f-8086-5e7c5e4ecd8d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "00aba53e-3870-4157-ace9-c2d252198e11", "name": "Get a company - default", "request": { "urlPathTemplate": "/companies/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"attributes\": {\n \"created_at\": \"2022-01-13T19:04:24.376+05:30\",\n \"domain\": \"xyz\",\n \"last_updated_at\": \"2022-04-01T18:47:48.283+05:30\",\n \"name\": \"text\",\n \"number_of_contacts\": 0,\n \"owner\": \"62260474111b1101704a9d85\",\n \"owner_assign_date\": \"2022-04-01T18:21:13.379+05:30\",\n \"phone_number\": 8171844192,\n \"revenue\": 10\n },\n \"id\": \"629475917295261d9b1f4403\",\n \"linkedContactsIds\": [\n 1,\n 2,\n 3\n ],\n \"linkedDealsIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "00aba53e-3870-4157-ace9-c2d252198e11", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ed72bcbe-33c2-48e2-93e4-756a46e8fd90", "name": "Delete a company - default", "request": { "urlPathTemplate": "/companies/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "ed72bcbe-33c2-48e2-93e4-756a46e8fd90", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "3d37f940-80db-41f6-9f83-1f3a2c69804b", "name": "Update a company - default", "request": { "urlPathTemplate": "/companies/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"attributes\": {\n \"created_at\": \"2022-01-13T19:04:24.376+05:30\",\n \"domain\": \"xyz\",\n \"last_updated_at\": \"2022-04-01T18:47:48.283+05:30\",\n \"name\": \"text\",\n \"number_of_contacts\": 0,\n \"owner\": \"62260474111b1101704a9d85\",\n \"owner_assign_date\": \"2022-04-01T18:21:13.379+05:30\",\n \"phone_number\": 8171844192,\n \"revenue\": 10\n },\n \"id\": \"629475917295261d9b1f4403\",\n \"linkedContactsIds\": [\n 1,\n 2,\n 3\n ],\n \"linkedDealsIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "3d37f940-80db-41f6-9f83-1f3a2c69804b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1a24ce32-7c2c-41a5-80a9-1681d05767ad", "name": "Create a company/deal attribute - default", "request": { "urlPathTemplate": "/crm/attributes", "method": "POST" }, "response": { "status": 200, "body": "{\n \"id\": \"61a5cd07ca1347c82306ad07\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1a24ce32-7c2c-41a5-80a9-1681d05767ad", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "360c88d6-c7bb-4c00-b1ab-146f803e9eff", "name": "Delete an attribute - default", "request": { "urlPathTemplate": "/crm/attributes/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "360c88d6-c7bb-4c00-b1ab-146f803e9eff", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a9790cec-51da-4b91-ae52-a3b58fa8c717", "name": "Update an attribute - default", "request": { "urlPathTemplate": "/crm/attributes/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "a9790cec-51da-4b91-ae52-a3b58fa8c717", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "696b098d-c426-490d-993d-82b72a9a6eec", "name": "Get company attributes - default", "request": { "urlPathTemplate": "/crm/attributes/companies", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"attributeOptions\": [\n {\n \"key\": \"custom key\",\n \"value\": \"custom label\"\n }\n ],\n \"attributeTypeName\": \"text\",\n \"internalName\": \"name\",\n \"isRequired\": true,\n \"label\": \"Company Name\"\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "696b098d-c426-490d-993d-82b72a9a6eec", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "3db982e0-00b7-41af-bc9d-fe3f54d90a12", "name": "Get deal attributes - default", "request": { "urlPathTemplate": "/crm/attributes/deals", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"attributeOptions\": [\n {\n \"key\": \"custom key\",\n \"value\": \"custom label\"\n }\n ],\n \"attributeTypeName\": \"text\",\n \"internalName\": \"deal_name\",\n \"isRequired\": true,\n \"label\": \"Deal Name\"\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "3db982e0-00b7-41af-bc9d-fe3f54d90a12", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "4ee2c155-e8d9-4aee-b095-699a2c9a6263", "name": "Get all deals - default", "request": { "urlPathTemplate": "/crm/deals", "method": "GET" }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"attributes\": {\n \"amount\": 12,\n \"created_at\": \"2022-05-30T07:42:05.671Z\",\n \"deal_name\": \"testname\",\n \"deal_owner\": \"6093d2425a9b436e9519d034\",\n \"deal_stage\": \"9e577ff7-8e42-4ab3-be26-2b5e01b42518\",\n \"last_activity_date\": \"2022-06-06T08:38:36.000Z\",\n \"last_updated_date\": \"2022-06-06T08:38:36.761Z\",\n \"number_of_activities\": 0,\n \"number_of_contacts\": 1,\n \"pipeline\": \"6093d296ad1e9c5cf2140a58\",\n \"stage_updated_at\": \"2022-05-30T07:42:05.671Z\"\n },\n \"id\": \"629475917295261d9b1f4403\",\n \"linkedCompaniesIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"linkedContactsIds\": [\n 1,\n 2,\n 3\n ]\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "4ee2c155-e8d9-4aee-b095-699a2c9a6263", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "21216821-874f-4e2a-a690-4b805b03c721", "name": "Create a deal - default", "request": { "urlPathTemplate": "/crm/deals", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"61a5cd07ca1347c82306ad06\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "21216821-874f-4e2a-a690-4b805b03c721", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ce9e7723-550c-4f51-af88-6cde553f45b7", "name": "Import deals(creation and updation) - default", "request": { "urlPathTemplate": "/crm/deals/import", "method": "POST" }, "response": { "status": 200, "body": "{\n \"processId\": 50\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ce9e7723-550c-4f51-af88-6cde553f45b7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f89fa5e6-0434-46e0-8c77-535bea98fc1a", "name": "Link and Unlink a deal with contacts and companies - default", "request": { "urlPathTemplate": "/crm/deals/link-unlink/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "f89fa5e6-0434-46e0-8c77-535bea98fc1a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "a3513f5b-5df8-443d-aa67-5efd91e58f3d", "name": "Get a deal - default", "request": { "urlPathTemplate": "/crm/deals/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"attributes\": {\n \"amount\": 12,\n \"created_at\": \"2022-05-30T07:42:05.671Z\",\n \"deal_name\": \"testname\",\n \"deal_owner\": \"6093d2425a9b436e9519d034\",\n \"deal_stage\": \"9e577ff7-8e42-4ab3-be26-2b5e01b42518\",\n \"last_activity_date\": \"2022-06-06T08:38:36.000Z\",\n \"last_updated_date\": \"2022-06-06T08:38:36.761Z\",\n \"next_activity_date\": {\n \"key\": \"value\"\n },\n \"number_of_activities\": 0,\n \"number_of_contacts\": 1,\n \"pipeline\": \"6093d296ad1e9c5cf2140a58\",\n \"stage_updated_at\": \"2022-05-30T07:42:05.671Z\"\n },\n \"id\": \"629475917295261d9b1f4403\",\n \"linkedCompaniesIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"linkedContactsIds\": [\n 1,\n 2,\n 3\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a3513f5b-5df8-443d-aa67-5efd91e58f3d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "54ba1660-4170-41b9-86d2-963468e28812", "name": "Delete a deal - default", "request": { "urlPathTemplate": "/crm/deals/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "54ba1660-4170-41b9-86d2-963468e28812", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "e555066b-bfb4-4582-9f37-6eec50af9fe4", "name": "Update a deal - default", "request": { "urlPathTemplate": "/crm/deals/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "e555066b-bfb4-4582-9f37-6eec50af9fe4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "00d065e6-8a4f-4ac9-a849-298a81551e9c", "name": "Get pipeline stages - default", "request": { "urlPathTemplate": "/crm/pipeline/details", "method": "GET" }, "response": { "status": 200, "body": "{\n \"pipeline\": \"5ea675e3da0dd085acaea610\",\n \"pipeline_name\": \"Sales Pipeline\",\n \"stages\": [\n {\n \"id\": \"9e577ff7-8e42-4ab3-be26-2b5e01b42518\",\n \"name\": \"New\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "00d065e6-8a4f-4ac9-a849-298a81551e9c", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "e75093b9-5f73-46e0-a2af-1f7c47922829", "name": "Get all pipelines - default", "request": { "urlPathTemplate": "/crm/pipeline/details/all", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"pipeline\": \"5ea675e3da0dd085acaea610\",\n \"pipeline_name\": \"Sales Pipeline\",\n \"stages\": [\n {\n \"id\": \"9e577ff7-8e42-4ab3-be26-2b5e01b42518\",\n \"name\": \"New\"\n }\n ]\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "e75093b9-5f73-46e0-a2af-1f7c47922829", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "2882799f-edf8-4d3b-826d-3692f300d025", "name": "Get a pipeline - default", "request": { "urlPathTemplate": "/crm/pipeline/details/{pipelineID}", "method": "GET", "pathParameters": { "pipelineID": { "equalTo": "pipelineID" } } }, "response": { "status": 200, "body": "[\n {\n \"pipeline\": \"5ea675e3da0dd085acaea610\",\n \"pipeline_name\": \"Sales Pipeline\",\n \"stages\": [\n {\n \"id\": \"9e577ff7-8e42-4ab3-be26-2b5e01b42518\",\n \"name\": \"New\"\n }\n ]\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "2882799f-edf8-4d3b-826d-3692f300d025", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "2e96e9dc-f52d-4354-a185-de3257903a02", "name": "Get all files - default", "request": { "urlPathTemplate": "/crm/files", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"authorId\": \"61a5ce58y5d4795761045991\",\n \"companyId\": \"61a5ce58c5d4795761045991\",\n \"contactId\": 1,\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"dealId\": \"61a5ce58c5d4795761045991\",\n \"name\": \"example.png\",\n \"size\": 10\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "2e96e9dc-f52d-4354-a185-de3257903a02", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "54153a26-e96d-4b54-acab-08a1b6bb6027", "name": "Upload a file - default", "request": { "urlPathTemplate": "/crm/files", "method": "POST" }, "response": { "status": 201, "body": "{\n \"authorId\": \"61a5ce58y5d4795761045991\",\n \"companyId\": \"61a5ce58c5d4795761045991\",\n \"contactId\": 1,\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"dealId\": \"61a5ce58c5d4795761045991\",\n \"name\": \"example.png\",\n \"size\": 10\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "54153a26-e96d-4b54-acab-08a1b6bb6027", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fea850a9-ab2c-4fee-89b8-e564df22e53a", "name": "Download a file - default", "request": { "urlPathTemplate": "/crm/files/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"fileUrl\": \"https://storage.googleapis.com/brevo-app-crm.......-sample.pdf\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fea850a9-ab2c-4fee-89b8-e564df22e53a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "38b72322-9ea0-47f2-b639-7d466c243b82", "name": "Delete a file - default", "request": { "urlPathTemplate": "/crm/files/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "38b72322-9ea0-47f2-b639-7d466c243b82", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1ee1505b-b76c-47f3-addc-8d237075f2a3", "name": "Get file details - default", "request": { "urlPathTemplate": "/crm/files/{id}/data", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"authorId\": \"61a5ce58y5d4795761045991\",\n \"companyId\": \"61a5ce58c5d4795761045991\",\n \"contactId\": 1,\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"dealId\": \"61a5ce58c5d4795761045991\",\n \"name\": \"example.png\",\n \"size\": 10\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "1ee1505b-b76c-47f3-addc-8d237075f2a3", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "608a87de-9e4a-45e5-bb3a-e0683eb220b8", "name": "Get all notes - default", "request": { "urlPathTemplate": "/crm/notes", "method": "GET" }, "response": { "status": 200, "body": "[\n {\n \"authorId\": {\n \"email\": \"johndoe@example.com\",\n \"id\": \"61a5ce58y5d4795761045991\",\n \"locale\": \"en_GB\",\n \"name\": {\n \"fullName\": \"John Doe\"\n },\n \"timezone\": \"Asia/Kolkata\"\n },\n \"contactIds\": [\n 247,\n 1,\n 2\n ],\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"dealIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\"\n ],\n \"id\": \"61a5cd07ca1347c82306ad09\",\n \"text\": \"In communication with client_dev for resolution of queries.\",\n \"updatedAt\": \"2017-05-01T17:05:03Z\"\n }\n]", "headers": { "Content-Type": "application/json" } }, "uuid": "608a87de-9e4a-45e5-bb3a-e0683eb220b8", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "0ceb328a-0b27-4d1d-8ba3-3abc8979d485", "name": "Create a note - default", "request": { "urlPathTemplate": "/crm/notes", "method": "POST" }, "response": { "status": 200, "body": "{\n \"id\": \"61a5cd07ca1347c82306ad09\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0ceb328a-0b27-4d1d-8ba3-3abc8979d485", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f9cf8ca7-3372-4b74-854e-93a3d45c5d56", "name": "Get a note - default", "request": { "urlPathTemplate": "/crm/notes/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"authorId\": {\n \"email\": \"johndoe@example.com\",\n \"id\": \"61a5ce58y5d4795761045991\",\n \"locale\": \"en_GB\",\n \"name\": {\n \"fullName\": \"John Doe\"\n },\n \"timezone\": \"Asia/Kolkata\"\n },\n \"contactIds\": [\n 247,\n 1,\n 2\n ],\n \"createdAt\": \"2017-05-01T17:05:03Z\",\n \"dealIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\"\n ],\n \"id\": \"61a5cd07ca1347c82306ad09\",\n \"text\": \"In communication with client_dev for resolution of queries.\",\n \"updatedAt\": \"2017-05-01T17:05:03Z\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "f9cf8ca7-3372-4b74-854e-93a3d45c5d56", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "b382d16e-0455-423c-9dd1-42efa255a495", "name": "Delete a note - default", "request": { "urlPathTemplate": "/crm/notes/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "b382d16e-0455-423c-9dd1-42efa255a495", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "458a7a9b-298d-44e2-a117-63db0c9047f0", "name": "Update a note - default", "request": { "urlPathTemplate": "/crm/notes/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "458a7a9b-298d-44e2-a117-63db0c9047f0", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ce9a81b3-1605-4c76-bf79-fc52ff6a2653", "name": "Get all tasks - default", "request": { "urlPathTemplate": "/crm/tasks", "method": "GET" }, "response": { "status": 200, "body": "{\n \"items\": [\n {\n \"companiesIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"contactsIds\": [\n 1,\n 2,\n 3\n ],\n \"dealsIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"id\": \"61a5cd07ca1347c82306ad06\",\n \"name\": \"Task: Connect with client_dev\",\n \"taskTypeId\": \"61a5cd07ca1347c82306ad09\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "ce9a81b3-1605-4c76-bf79-fc52ff6a2653", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "60ee1139-00c5-4746-b240-523605d43bb4", "name": "Create a task - default", "request": { "urlPathTemplate": "/crm/tasks", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": \"61a5cd07ca1347c82306ad06\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "60ee1139-00c5-4746-b240-523605d43bb4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "909b9f4c-1f5b-4271-82fe-a4e4847db6c7", "name": "Get a task - default", "request": { "urlPathTemplate": "/crm/tasks/{id}", "method": "GET", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "{\n \"companiesIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"contactsIds\": [\n 1,\n 2,\n 3\n ],\n \"dealsIds\": [\n \"61a5ce58c5d4795761045990\",\n \"61a5ce58c5d4795761045991\",\n \"61a5ce58c5d4795761045992\"\n ],\n \"id\": \"61a5cd07ca1347c82306ad06\",\n \"name\": \"Task: Connect with client_dev\",\n \"taskTypeId\": \"61a5cd07ca1347c82306ad09\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "909b9f4c-1f5b-4271-82fe-a4e4847db6c7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "040ca6a6-b7b7-4cfd-95b2-a493ccc1691e", "name": "Delete a task - default", "request": { "urlPathTemplate": "/crm/tasks/{id}", "method": "DELETE", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "040ca6a6-b7b7-4cfd-95b2-a493ccc1691e", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "90199d04-c868-46bf-8e40-5e330c257e75", "name": "Update a task - default", "request": { "urlPathTemplate": "/crm/tasks/{id}", "method": "PATCH", "pathParameters": { "id": { "equalTo": "id" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "90199d04-c868-46bf-8e40-5e330c257e75", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "667b0721-7004-49d8-9017-b6d086394c2f", "name": "Get all task types - default", "request": { "urlPathTemplate": "/crm/tasktypes", "method": "GET" }, "response": { "status": 200, "body": "{\n \"id\": \"61a88a2eb7a574180261234\",\n \"title\": \"Email\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "667b0721-7004-49d8-9017-b6d086394c2f", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "22a7a09a-6fad-41dd-aed4-b8806c57a34a", "name": "Send a WhatsApp message - default", "request": { "urlPathTemplate": "/whatsapp/sendMessage", "method": "POST" }, "response": { "status": 201, "body": "{\n \"messageId\": \"23befbae-1505-47a8-bd27-e30ef739f32c\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "22a7a09a-6fad-41dd-aed4-b8806c57a34a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "fab3ac15-a813-4c2f-9673-e64845544c00", "name": "Get all your WhatsApp activity (unaggregated events) - default", "request": { "urlPathTemplate": "/whatsapp/statistics/events", "method": "GET" }, "response": { "status": 200, "body": "{\n \"events\": [\n {\n \"body\": \"Hi! I am a reply\",\n \"contactNumber\": \"contactNumber\",\n \"date\": \"2017-03-12T12:30:00Z\",\n \"event\": \"sent\",\n \"mediaUrl\": \"https://example.com/media.png\",\n \"messageId\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"reason\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"senderNumber\": \"senderNumber\"\n },\n {\n \"body\": \"Hi! I am a reply\",\n \"contactNumber\": \"contactNumber\",\n \"date\": \"2017-03-12T12:30:00Z\",\n \"event\": \"error\",\n \"mediaUrl\": \"https://example.com/media.png\",\n \"messageId\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"reason\": \"error reason\",\n \"senderNumber\": \"senderNumber\"\n },\n {\n \"body\": \"Hi! I am a reply\",\n \"contactNumber\": \"contactNumber\",\n \"date\": \"2017-03-12T12:30:00Z\",\n \"event\": \"soft-bounce\",\n \"mediaUrl\": \"https://example.com/media.png\",\n \"messageId\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"reason\": \"invalid whatsapp contact\",\n \"senderNumber\": \"senderNumber\"\n },\n {\n \"body\": \"body only in case of text reply & url will be empty\",\n \"contactNumber\": \"contactNumber\",\n \"date\": \"2017-03-12T12:30:00Z\",\n \"event\": \"reply\",\n \"mediaUrl\": \"media url only in case media reply & body will be empty\",\n \"messageId\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"reason\": \"23befbae-1505-47a8-bd27-e30ef739f32c\",\n \"senderNumber\": \"senderNumber\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "fab3ac15-a813-4c2f-9673-e64845544c00", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "28f43c06-69ca-463d-ad60-4a71c61a0440", "name": "Get the list of blocked or unsubscribed transactional contacts - default", "request": { "urlPathTemplate": "/smtp/blockedContacts", "method": "GET" }, "response": { "status": 200, "body": "{\n \"contacts\": [\n {\n \"blockedAt\": \"2017-05-01T12:30:00Z\",\n \"email\": \"abc@xyz.com\",\n \"reason\": {\n \"code\": \"adminBlocked\",\n \"message\": \"Admin blocked\"\n },\n \"senderEmail\": \"ez312@gmal.com\"\n }\n ],\n \"count\": 1\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "28f43c06-69ca-463d-ad60-4a71c61a0440", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "e81c8495-0ef3-44b1-a9ce-45cc2bef7798", "name": "Unblock or resubscribe a transactional contact - default", "request": { "urlPathTemplate": "/smtp/blockedContacts/{email}", "method": "DELETE", "pathParameters": { "email": { "equalTo": "email" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "e81c8495-0ef3-44b1-a9ce-45cc2bef7798", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0aab435d-618c-452b-8545-7c35e9088c78", "name": "Get the list of blocked domains - default", "request": { "urlPathTemplate": "/smtp/blockedDomains", "method": "GET" }, "response": { "status": 200, "body": "{\n \"domains\": [\n \"example.com\",\n \"testdomain.com\"\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0aab435d-618c-452b-8545-7c35e9088c78", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "350fd1cc-de1c-4197-ae49-46ce6a1d6c03", "name": "Add a new domain to the list of blocked domains - default", "request": { "urlPathTemplate": "/smtp/blockedDomains", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "350fd1cc-de1c-4197-ae49-46ce6a1d6c03", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "f5e28407-a9c3-4231-b722-a6b8bbd8af4a", "name": "Unblock an existing domain from the list of blocked domains - default", "request": { "urlPathTemplate": "/smtp/blockedDomains/{domain}", "method": "DELETE", "pathParameters": { "domain": { "equalTo": "domain" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "f5e28407-a9c3-4231-b722-a6b8bbd8af4a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "d0e027cd-c123-40e7-9aad-30cdce7cf01d", "name": "Delete hardbounces - default", "request": { "urlPathTemplate": "/smtp/deleteHardbounces", "method": "POST" }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "d0e027cd-c123-40e7-9aad-30cdce7cf01d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "4682dc2f-8d22-401b-bb70-9d7939f0b7f7", "name": "Send a transactional email - default", "request": { "urlPathTemplate": "/smtp/email", "method": "POST" }, "response": { "status": 201, "body": "{\n \"messageId\": \"<201798300811.5787683@relay.domain.com>\",\n \"messageIds\": [\n \"messageIds\"\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "4682dc2f-8d22-401b-bb70-9d7939f0b7f7", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "5b6bfccd-a5f9-44e8-ab53-d5429f8f9e49", "name": "Delete scheduled emails by batchId or messageId - default", "request": { "urlPathTemplate": "/smtp/email/{identifier}", "method": "DELETE", "pathParameters": { "identifier": { "equalTo": "4320f270-a4e3-4a2e-b591-edfe30a5e627" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "5b6bfccd-a5f9-44e8-ab53-d5429f8f9e49", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "7b3f5d29-5b44-4d25-ba1b-9b35d7e1bb44", "name": "Fetch scheduled emails by batchId or messageId - default", "request": { "urlPathTemplate": "/smtp/emailStatus/{identifier}", "method": "GET", "pathParameters": { "identifier": { "equalTo": "4320f270-a4e3-4a2e-b591-edfe30a5e627" } } }, "response": { "status": 200, "body": "{\n \"batches\": [\n {\n \"createdAt\": \"2022-02-26T11:36:43Z\",\n \"scheduledAt\": \"2022-02-28T11:36:43Z\",\n \"status\": \"queued\"\n },\n {\n \"createdAt\": \"2022-02-24T11:36:43Z\",\n \"scheduledAt\": \"2022-02-25T11:36:43Z\",\n \"status\": \"processed\"\n },\n {\n \"createdAt\": \"2022-02-25T11:36:43Z\",\n \"scheduledAt\": \"2022-02-26T11:36:43Z\",\n \"status\": \"inProgress\"\n }\n ],\n \"count\": 3\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "7b3f5d29-5b44-4d25-ba1b-9b35d7e1bb44", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "59d3278a-2ea0-47c9-9d55-a4046d1b1377", "name": "Get the list of transactional emails on the basis of allowed filters - default", "request": { "urlPathTemplate": "/smtp/emails", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 120,\n \"transactionalEmails\": [\n {\n \"date\": \"2019-05-25T11:53:26Z\",\n \"email\": \"abc@xyz.com\",\n \"from\": \"diana.doe@example.com\",\n \"messageId\": \"<201798300811.5787683@relay.domain.com>\",\n \"subject\": \"summer camp\",\n \"tags\": [\n \"tag1\"\n ],\n \"templateId\": 15,\n \"uuid\": \"5a78c-209ok98262910-std2341\"\n },\n {\n \"date\": \"2019-05-25T07:28:11Z\",\n \"email\": \"test@test.com\",\n \"from\": \"diana.doe@example.com\",\n \"messageId\": \"<201798300811.5700093@relay.domain.com>\",\n \"subject\": \"details verification\",\n \"tags\": [\n \"tag1\"\n ],\n \"templateId\": 15,\n \"uuid\": \"5a78c-209ok98262910-s99a341\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "59d3278a-2ea0-47c9-9d55-a4046d1b1377", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "242bc913-9644-453e-a76b-b6898985c451", "name": "Get the personalized content of a sent transactional email - default", "request": { "urlPathTemplate": "/smtp/emails/{uuid}", "method": "GET", "pathParameters": { "uuid": { "equalTo": "uuid" } } }, "response": { "status": 200, "body": "{\n \"attachmentCount\": 2,\n \"body\": \"

Greetings from the team

This is the actual html content sent

\",\n \"date\": \"2016-02-25T11:53:26Z\",\n \"email\": \"abc@example.com\",\n \"events\": [\n {\n \"name\": \"sent\",\n \"time\": \"2016-02-25T11:53:26Z\"\n },\n {\n \"name\": \"delivered\",\n \"time\": \"2016-02-25T11:55:26Z\"\n },\n {\n \"name\": \"opened\",\n \"time\": \"2016-02-26T09:53:26Z\"\n }\n ],\n \"subject\": \"Summer Camps\",\n \"templateId\": 12\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "242bc913-9644-453e-a76b-b6898985c451", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "1060a95a-b193-4fcb-a2c0-82a02a746067", "name": "Delete an SMTP transactional log - default", "request": { "urlPathTemplate": "/smtp/log/{identifier}", "method": "DELETE", "pathParameters": { "identifier": { "equalTo": "identifier" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "1060a95a-b193-4fcb-a2c0-82a02a746067", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "4506e73c-7b47-483f-9ffc-09cb13f3d99a", "name": "Get your transactional email activity aggregated over a period of time - default", "request": { "urlPathTemplate": "/smtp/statistics/aggregatedReport", "method": "GET" }, "response": { "status": 200, "body": "{\n \"blocked\": 2,\n \"clicks\": 9987,\n \"delivered\": 18996,\n \"hardBounces\": 234,\n \"invalid\": 0,\n \"opens\": 17654,\n \"range\": \"2016-09-08|2017-04-28\",\n \"requests\": 19887,\n \"softBounces\": 1533,\n \"spamReports\": 1,\n \"uniqueClicks\": 8766,\n \"uniqueOpens\": 13688,\n \"unsubscribed\": 2\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "4506e73c-7b47-483f-9ffc-09cb13f3d99a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "a81e1c33-f793-49d1-adb6-8083ca10de20", "name": "Get all your transactional email activity (unaggregated events) - default", "request": { "urlPathTemplate": "/smtp/statistics/events", "method": "GET" }, "response": { "status": 200, "body": "{\n \"events\": [\n {\n \"date\": \"2017-03-12T12:30:00Z\",\n \"email\": \"john.smith@example.com\",\n \"event\": \"deferred\",\n \"from\": \"john@example.com\",\n \"ip\": \"165.87.3.15\",\n \"link\": \"https://www.someexamplelink.com\",\n \"messageId\": \"<201798300811.5787683@example.domain.com>\",\n \"reason\": \"Error connection timeout\",\n \"subject\": \"Sib client_dev test\",\n \"tag\": \"OrderConfirmation\",\n \"templateId\": 4\n },\n {\n \"date\": \"2017-03-13T16:30:00Z\",\n \"email\": \"john.smith@example.com\",\n \"event\": \"delivered\",\n \"from\": \"john@example.com\",\n \"ip\": \"165.87.3.15\",\n \"link\": \"https://www.someexamplelink.com\",\n \"messageId\": \"<201798300811.5787683@example.domain.com>\",\n \"reason\": \"Error connection timeout\",\n \"subject\": \"Sib client_dev test\",\n \"tag\": \"OrderConfirmation\",\n \"templateId\": 5\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a81e1c33-f793-49d1-adb6-8083ca10de20", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "0d36a3c1-9ba5-4da3-9f9a-5d81dcb8cbc6", "name": "Get your transactional email activity aggregated per day - default", "request": { "urlPathTemplate": "/smtp/statistics/reports", "method": "GET" }, "response": { "status": 200, "body": "{\n \"reports\": [\n {\n \"blocked\": 519,\n \"clicks\": 1026,\n \"date\": \"2017-04-30\",\n \"delivered\": 10103,\n \"hardBounces\": 21,\n \"invalid\": 1,\n \"opens\": 5091,\n \"requests\": 10756,\n \"softBounces\": 137,\n \"spamReports\": 0,\n \"uniqueClicks\": 720,\n \"uniqueOpens\": 2318,\n \"unsubscribed\": 0\n },\n {\n \"blocked\": 920,\n \"clicks\": 1514,\n \"date\": \"2017-05-01\",\n \"delivered\": 17499,\n \"hardBounces\": 34,\n \"invalid\": 2,\n \"opens\": 10089,\n \"requests\": 18812,\n \"softBounces\": 254,\n \"spamReports\": 0,\n \"uniqueClicks\": 1090,\n \"uniqueOpens\": 4393,\n \"unsubscribed\": 3\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0d36a3c1-9ba5-4da3-9f9a-5d81dcb8cbc6", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "81e1ac28-8b42-4ff7-a4f4-ad4a4fe0d149", "name": "Generate the rendered preview of transactional template - default", "request": { "urlPathTemplate": "/smtp/template/preview", "method": "POST" }, "response": { "status": 200, "body": "{\n \"fromEmail\": \"fromEmail\",\n \"fromName\": \"fromName\",\n \"html\": \"html\",\n \"previewText\": \"previewText\",\n \"subject\": \"subject\",\n \"usedFeedNames\": [\n \"usedFeedNames\",\n \"usedFeedNames\"\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "81e1ac28-8b42-4ff7-a4f4-ad4a4fe0d149", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "0e4d0a9a-9763-4d0b-92ab-7b1483ddd81b", "name": "Get the list of email templates - default", "request": { "urlPathTemplate": "/smtp/templates", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 2,\n \"templates\": [\n {\n \"createdAt\": \"2016-02-24T14:44:24Z\",\n \"doiTemplate\": false,\n \"htmlContent\": \"HTML CONTENT 1\",\n \"id\": 5,\n \"isActive\": false,\n \"modifiedAt\": \"2016-02-24T15:37:11Z\",\n \"name\": \"ChristomasTimeTemplate\",\n \"replyTo\": \"replyto@domain.com\",\n \"sender\": {\n \"email\": \"john.smith@example.com\",\n \"id\": \"43\",\n \"name\": \"John\"\n },\n \"subject\": \"Merry Christmas\",\n \"tag\": \"Festival\",\n \"testSent\": false,\n \"toField\": \"\"\n },\n {\n \"createdAt\": \"2016-02-25T11:53:26Z\",\n \"doiTemplate\": false,\n \"htmlContent\": \"HTML CONTENT 2\",\n \"id\": 12,\n \"isActive\": true,\n \"modifiedAt\": \"2016-02-25T11:53:26Z\",\n \"name\": \"SummerSales2017Template\",\n \"replyTo\": \"replyto@domain.com\",\n \"sender\": {\n \"email\": \"john.smith@example.com\",\n \"id\": \"43\",\n \"name\": \"John\"\n },\n \"subject\": \"Enjoy our summer Sales !\",\n \"tag\": \"Summer\",\n \"testSent\": false,\n \"toField\": \"\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "0e4d0a9a-9763-4d0b-92ab-7b1483ddd81b", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "a7314e1c-958e-4335-9dd3-e65802b21168", "name": "Create an email template - default", "request": { "urlPathTemplate": "/smtp/templates", "method": "POST" }, "response": { "status": 201, "body": "{\n \"id\": 5\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "a7314e1c-958e-4335-9dd3-e65802b21168", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "845ecf0d-a02f-461d-908b-25fe3eab4ec9", "name": "Returns the template information - default", "request": { "urlPathTemplate": "/smtp/templates/{templateId}", "method": "GET", "pathParameters": { "templateId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "{\n \"createdAt\": \"2016-02-25T11:53:26Z\",\n \"doiTemplate\": false,\n \"htmlContent\": \"HTML CONTENT 4\",\n \"id\": 33,\n \"isActive\": true,\n \"modifiedAt\": \"2016-02-25T11:53:26Z\",\n \"name\": \"OrderConfirmation\",\n \"replyTo\": \"replyto@domain.com\",\n \"sender\": {\n \"email\": \"john.smith@example.com\",\n \"id\": \"43\",\n \"name\": \"John\"\n },\n \"subject\": \"Order Confirmation : Thanks for your Purchase !\",\n \"tag\": \"\",\n \"testSent\": false,\n \"toField\": \"\"\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "845ecf0d-a02f-461d-908b-25fe3eab4ec9", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "65a53a30-7428-4b1a-b0a4-88869d5b8d78", "name": "Update an email template - default", "request": { "urlPathTemplate": "/smtp/templates/{templateId}", "method": "PUT", "pathParameters": { "templateId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "65a53a30-7428-4b1a-b0a4-88869d5b8d78", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "ee12d2af-6eea-4dd3-b43d-ca1463b36b14", "name": "Delete an inactive email template - default", "request": { "urlPathTemplate": "/smtp/templates/{templateId}", "method": "DELETE", "pathParameters": { "templateId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "ee12d2af-6eea-4dd3-b43d-ca1463b36b14", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "10979c60-afa4-4a94-a43e-5fc9613e22da", "name": "Send a template to your test list - default", "request": { "urlPathTemplate": "/smtp/templates/{templateId}/sendTest", "method": "POST", "pathParameters": { "templateId": { "equalTo": "1000000" } } }, "response": { "status": 200, "body": "\"\"", "headers": { "Content-Type": "application/json" } }, "uuid": "10979c60-afa4-4a94-a43e-5fc9613e22da", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "df5bc4e6-ca5e-4cd7-809c-269c0845b24d", "name": "Send SMS message asynchronously to a mobile number - default", "request": { "urlPathTemplate": "/transactionalSMS/send", "method": "POST" }, "response": { "status": 201, "body": "{\n \"messageId\": 1511882900176220\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "df5bc4e6-ca5e-4cd7-809c-269c0845b24d", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "70d5f369-4f59-482d-a10b-be3e50b4a40a", "name": "Send SMS message to a mobile number - default", "request": { "urlPathTemplate": "/transactionalSMS/sms", "method": "POST" }, "response": { "status": 201, "body": "{\n \"messageId\": 1511882900176220,\n \"reference\": \"ab1cde2fgh3i4jklmno\",\n \"remainingCredits\": 82.85,\n \"smsCount\": 2,\n \"usedCredits\": 0.7\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "70d5f369-4f59-482d-a10b-be3e50b4a40a", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } } }, { "id": "31feec95-40fc-4b7e-9c08-86c997f2dfb0", "name": "Get your SMS activity aggregated over a period of time - default", "request": { "urlPathTemplate": "/transactionalSMS/statistics/aggregatedReport", "method": "GET" }, "response": { "status": 200, "body": "{\n \"accepted\": 6,\n \"blocked\": 4,\n \"delivered\": 16,\n \"hardBounces\": 5,\n \"range\": \"2015-05-22|2017-11-29\",\n \"rejected\": 14,\n \"replied\": 8,\n \"requests\": 54,\n \"skipped\": 1,\n \"softBounces\": 26,\n \"unsubscribed\": 10\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "31feec95-40fc-4b7e-9c08-86c997f2dfb0", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "8bec6502-a4a6-4405-88f8-c7b97f2bc0e4", "name": "Get all your SMS activity (unaggregated events) - default", "request": { "urlPathTemplate": "/transactionalSMS/statistics/events", "method": "GET" }, "response": { "status": 200, "body": "{\n \"events\": [\n {\n \"date\": \"2015-05-20T12:30:00Z\",\n \"event\": \"sent\",\n \"messageId\": \"1473139351170140\",\n \"phoneNumber\": \"phoneNumber\",\n \"reason\": \"Recipient is currently unreachable\",\n \"reply\": \"reply\",\n \"tag\": \"cabWaiting\"\n },\n {\n \"date\": \"2015-05-20T16:30:00Z\",\n \"event\": \"delivered\",\n \"messageId\": \"1473139351170140\",\n \"phoneNumber\": \"phoneNumber\",\n \"reason\": \"Recipient is currently unreachable\",\n \"reply\": \"reply\",\n \"tag\": \"cabRequest\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "8bec6502-a4a6-4405-88f8-c7b97f2bc0e4", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "34ebfec8-ca13-4071-9f58-e116c00c6446", "name": "Get your SMS activity aggregated per day - default", "request": { "urlPathTemplate": "/transactionalSMS/statistics/reports", "method": "GET" }, "response": { "status": 200, "body": "{\n \"reports\": [\n {\n \"accepted\": 2318,\n \"blocked\": 1026,\n \"date\": \"2017-04-30\",\n \"delivered\": 10103,\n \"hardBounces\": 21,\n \"rejected\": 0,\n \"replied\": 5091,\n \"requests\": 10756,\n \"skipped\": 1,\n \"softBounces\": 137,\n \"unsubscribed\": 720\n },\n {\n \"accepted\": 4393,\n \"blocked\": 1514,\n \"date\": \"2017-05-01\",\n \"delivered\": 17499,\n \"hardBounces\": 34,\n \"rejected\": 0,\n \"replied\": 10089,\n \"requests\": 18812,\n \"skipped\": 0,\n \"softBounces\": 254,\n \"unsubscribed\": 1090\n },\n {\n \"accepted\": 4689,\n \"blocked\": 1646,\n \"date\": \"2017-05-02\",\n \"delivered\": 13427,\n \"hardBounces\": 16,\n \"rejected\": 0,\n \"replied\": 11563,\n \"requests\": 14321,\n \"skipped\": 1,\n \"softBounces\": 176,\n \"unsubscribed\": 1170\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "34ebfec8-ca13-4071-9f58-e116c00c6446", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] }, { "id": "b2c77971-5a16-41bb-99c4-62a5707d47bb", "name": "Return all your created SMS templates - default", "request": { "urlPathTemplate": "/transactionalSMS/templates", "method": "GET" }, "response": { "status": 200, "body": "{\n \"count\": 1,\n \"templates\": [\n {\n \"id\": 4,\n \"name\": \"Order Confirmation - EN\",\n \"short_url_enabled\": false,\n \"message\": \"Thanks for your order !\",\n \"compliance\": {\n \"compliance_toggle\": true,\n \"organisation_prefix\": \"BREVO\",\n \"stop_keyword\": \"STOP\"\n },\n \"encryption\": true,\n \"unicode_sms\": true,\n \"media_file\": \"brv-logo.png\",\n \"media_file_size\": \"media_file_size\",\n \"media_url\": \"https://img-st2.mailinblue.com/1232/images/content_library/original/69282fe28f55fd22de6e0cf9.png\",\n \"createdAt\": \"2025-05-01T12:30:00Z\",\n \"updatedAt\": \"2025-05-01T12:30:00Z\"\n }\n ]\n}", "headers": { "Content-Type": "application/json" } }, "uuid": "b2c77971-5a16-41bb-99c4-62a5707d47bb", "persistent": true, "priority": 3, "metadata": { "mocklab": { "created": { "at": "2020-01-01T00:00:00.000Z", "via": "SYSTEM" } } }, "postServeActions": [] } ], "meta": { "total": 282 } }