{ "info": { "_postman_id": "2eb51293-fe16-443f-bedc-27a89ff7ad60", "name": "Twilio SendGrid Subusers", "description": "The Twilio SendGrid Subusers API allows you to create and manage your Subuser accounts. Subusers are available on [Pro and Premier plans](https://sendgrid.com/pricing), and you can think of them as sub-accounts. Each Subuser can have its own sending domains, IP addresses, and reporting. SendGrid recommends creating Subusers for each of the different types of emails you send\u2014one Subuser for transactional emails and another for marketing emails. Independent Software Vendor (ISV) customers may also create Subusers for each of their customers.\n\nYou can also manage Subusers in the [Twilio SendGrid application user interface](https://app.sendgrid.com/settings/subusers). See [**Subusers**](https://docs.sendgrid.com/ui/account-and-settings/subusers) for more information.\n\nContact Support:\n Name: Twilio SendGrid Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "lastUpdatedBy": "35240", "uid": "35240-2eb51293-fe16-443f-bedc-27a89ff7ad60" }, "item": [ { "name": "v3", "item": [ { "name": "subusers", "item": [ { "name": "{subuser_name}", "item": [ { "name": "website_access", "item": [ { "name": "Enable/Disable website access for a Subuser", "id": "27a4ea55-e5ff-489b-9bc6-ab5cd030da9c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/website_access", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "website_access" ], "variable": [ { "id": "7032d83b-629f-49b9-80cf-842d6659b980", "key": "subuser_name", "value": "", "description": "(Required) " } ] }, "description": "Enable/Disable website access for a Subuser, while still preserving email send functionality." }, "response": [ { "id": "76bc73a6-b731-4d1e-bee0-4f0123335385", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/website_access", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "website_access" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-76bc73a6-b731-4d1e-bee0-4f0123335385" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-27a4ea55-e5ff-489b-9bc6-ab5cd030da9c" } ], "id": "c528e21a-6bcb-438e-b0c8-87aba4f789d9", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-c528e21a-6bcb-438e-b0c8-87aba4f789d9" }, { "name": "credits", "item": [ { "name": "remaining", "item": [ { "name": "Update the remaining credits for a Subuser", "id": "ddaa3654-fffc-4a89-84a8-9321444fd550", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allocation_update\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits/remaining", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits", "remaining" ], "variable": [ { "id": "92b88ba1-84ff-40b3-bed3-fcda01ff8efd", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to update the remaining credits for a Subuser.**" }, "response": [ { "id": "b2b9e90f-6594-41cb-937f-62047f06229d", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"allocation_update\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits/remaining", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits", "remaining" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"recurring\",\n \"reset_frequency\": \"weekly\",\n \"remain\": \"\",\n \"total\": \"\",\n \"used\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-b2b9e90f-6594-41cb-937f-62047f06229d" }, { "id": "66c77ccd-9d49-4c84-a994-2e41459a38fa", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"allocation_update\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits/remaining", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits", "remaining" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-66c77ccd-9d49-4c84-a994-2e41459a38fa" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-ddaa3654-fffc-4a89-84a8-9321444fd550" } ], "id": "db993e23-4cd0-42a1-afc0-40b94225db3f", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-db993e23-4cd0-42a1-afc0-40b94225db3f" }, { "name": "Get the Credits for a Subuser", "id": "63f6c27d-686e-44d8-9c2e-39126f0fce74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "id": "89f5055c-9bed-43ba-82ed-8fc9f71d7204", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to retrieve a Credits overview for a Subuser.**" }, "response": [ { "id": "afe644de-96ae-4c5f-a8ce-7eda479d34af", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"recurring\",\n \"reset_frequency\": \"weekly\",\n \"remain\": \"\",\n \"total\": \"\",\n \"used\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-afe644de-96ae-4c5f-a8ce-7eda479d34af" }, { "id": "bcb3f924-0977-4d4c-beb9-445774e89096", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-bcb3f924-0977-4d4c-beb9-445774e89096" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-63f6c27d-686e-44d8-9c2e-39126f0fce74" }, { "name": "Update the Credits for a Subuser", "id": "aee53e27-7585-405c-b4ee-539dbb85ad0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"nonrecurring\",\n \"reset_frequency\": \"daily\",\n \"total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "id": "e01b2b04-ddbf-4896-a6a7-cd8004c1d22f", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to update the Credits for a Subuser.**" }, "response": [ { "id": "bde37a88-5789-43e7-9a48-1260447ac44e", "name": "response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"nonrecurring\",\n \"reset_frequency\": \"daily\",\n \"total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"recurring\",\n \"reset_frequency\": \"weekly\",\n \"remain\": \"\",\n \"total\": \"\",\n \"used\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-bde37a88-5789-43e7-9a48-1260447ac44e" }, { "id": "ca410cdc-80f9-46d9-aef7-98263fd2c72a", "name": "response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"nonrecurring\",\n \"reset_frequency\": \"daily\",\n \"total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/credits", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "credits" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-ca410cdc-80f9-46d9-aef7-98263fd2c72a" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-aee53e27-7585-405c-b4ee-539dbb85ad0d" } ], "id": "2a274e3c-55cb-410d-b5e1-401f25e61db3", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-2a274e3c-55cb-410d-b5e1-401f25e61db3" }, { "name": "ips", "item": [ { "name": "Update IPs assigned to a subuser", "id": "60ed976c-ba30-41cf-bb6d-2d91d876f2d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/ips", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "ips" ], "variable": [ { "id": "55a666f7-b9e8-4d03-b4e6-306803454ddb", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you update your subusers' assigned IP.**\n\nEach subuser should be assigned to an IP address from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well. \n\nMore information:\n\n* [How to request more IPs](https://sendgrid.com/docs/ui/account-and-settings/dedicated-ip-addresses/)\n* [Setup Reverse DNS](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-reverse-dns/)" }, "response": [ { "id": "f616227f-7be6-4743-9b5b-63880d08b146", "name": "response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/ips", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "ips" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ips\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-f616227f-7be6-4743-9b5b-63880d08b146" }, { "id": "ac54a08d-0b7f-4c16-8a9e-a740994d347e", "name": "response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/ips", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "ips" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-ac54a08d-0b7f-4c16-8a9e-a740994d347e" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-60ed976c-ba30-41cf-bb6d-2d91d876f2d2" } ], "id": "ca987ce9-e579-4f92-bc36-5df06e10d1a6", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-ca987ce9-e579-4f92-bc36-5df06e10d1a6" }, { "name": "stats", "item": [ { "name": "monthly", "item": [ { "name": "Retrieve the monthly email statistics for a single subuser", "id": "854ba629-8b28-4896-bd06-d292ce490f5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/stats/monthly?date=&sort_by_metric=delivered&sort_by_direction=desc&limit=5&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "stats", "monthly" ], "query": [ { "description": "(Required) The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD", "key": "date", "value": "" }, { "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'", "key": "sort_by_metric", "value": "delivered" }, { "description": "The direction you want to sort.", "key": "sort_by_direction", "value": "desc" }, { "description": "Optional field to limit the number of results returned.", "key": "limit", "value": "5" }, { "description": "Optional beginning point in the list to retrieve from.", "key": "offset", "value": "0" } ], "variable": [ { "id": "fdb51a7b-3010-4b20-999f-b879c1529216", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to retrive the monthly email statistics for a specific subuser.**\n\nWhen using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics:\n`bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_report_drops`, `spam_reports`, or `unsubscribe_drops`." }, "response": [ { "id": "67ed8ef9-1eb4-4908-a6e7-8172b6c40579", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name/stats/monthly?date=&sort_by_metric=delivered&sort_by_direction=desc&limit=5&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name", "stats", "monthly" ], "query": [ { "description": "(Required) The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD", "key": "date", "value": "" }, { "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'", "key": "sort_by_metric", "value": "delivered" }, { "description": "The direction you want to sort.", "key": "sort_by_direction", "value": "desc" }, { "description": "Optional field to limit the number of results returned.", "key": "limit", "value": "5" }, { "description": "Optional beginning point in the list to retrieve from.", "key": "offset", "value": "0" } ], "variable": [ { "key": "subuser_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"date\": \"\",\n \"stats\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-67ed8ef9-1eb4-4908-a6e7-8172b6c40579" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-854ba629-8b28-4896-bd06-d292ce490f5a" } ], "id": "f8a2802d-36e7-455b-92c5-ebe1500bb02a", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-f8a2802d-36e7-455b-92c5-ebe1500bb02a" } ], "id": "a4c8fdf8-d77a-4fb4-b10a-19d4b55f476e", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-a4c8fdf8-d77a-4fb4-b10a-19d4b55f476e" }, { "name": "Enable/disable a subuser", "id": "61ff3566-8893-4b0b-b8f0-ff5be4fe7845", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "id": "85c434c3-0653-41da-8a1a-a9ba68bcc4f2", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to enable or disable a subuser.**" }, "response": [ { "id": "c35abb6b-6f19-4a87-b120-dc2e2520a32d", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-c35abb6b-6f19-4a87-b120-dc2e2520a32d" }, { "id": "f56696f5-a334-48f5-bf2f-34189fbff66e", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-f56696f5-a334-48f5-bf2f-34189fbff66e" }, { "id": "c190e5dc-835f-4d86-9bfa-91a865cd2b85", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-c190e5dc-835f-4d86-9bfa-91a865cd2b85" }, { "id": "8d053ad1-b74a-4e22-9886-6e29be01deb4", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-8d053ad1-b74a-4e22-9886-6e29be01deb4" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-61ff3566-8893-4b0b-b8f0-ff5be4fe7845" }, { "name": "Delete a subuser", "id": "806d82e1-1b32-4034-b9a5-cdc61fd3de03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "id": "a3dedb50-4eff-40fe-a1db-61eea315c747", "key": "subuser_name", "value": "", "description": "(Required) The username of the Subuser." } ] }, "description": "**This endpoint allows you to delete a subuser.**\n\nThis is a permanent action. Once deleted, a subuser cannot be retrieved." }, "response": [ { "id": "fbdc263d-42bf-499c-895e-b841293a27ba", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-fbdc263d-42bf-499c-895e-b841293a27ba" }, { "id": "28f35af4-de15-433b-991a-9700de76e962", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/:subuser_name", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", ":subuser_name" ], "variable": [ { "key": "subuser_name" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-28f35af4-de15-433b-991a-9700de76e962" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-806d82e1-1b32-4034-b9a5-cdc61fd3de03" } ], "id": "2a4720c1-978a-432b-96b3-3b2119f0ae84", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-2a4720c1-978a-432b-96b3-3b2119f0ae84" }, { "name": "reputations", "item": [ { "name": "Retrieve Subuser Reputations", "id": "94e092b3-9aa3-4383-9cfa-17538d8a7e91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/reputations?usernames=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "reputations" ], "query": [ { "key": "usernames", "value": "" } ] }, "description": "**This endpoint allows you to request the reputations for your subusers.**\n\nSubuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating." }, "response": [ { "id": "b4f103ee-0e9d-4cfd-9cc9-7814c336d314", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/reputations?usernames=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "reputations" ], "query": [ { "key": "usernames", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"reputation\": \"\",\n \"username\": \"\"\n },\n {\n \"reputation\": \"\",\n \"username\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-b4f103ee-0e9d-4cfd-9cc9-7814c336d314" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-94e092b3-9aa3-4383-9cfa-17538d8a7e91" } ], "id": "f73ef2e1-087b-4f6e-81a5-1919829d20ca", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-f73ef2e1-087b-4f6e-81a5-1919829d20ca" }, { "name": "stats", "item": [ { "name": "monthly", "item": [ { "name": "Retrieve monthly stats for all subusers", "id": "f3e0f62e-1f0b-4948-9666-2c7f9f9cb02d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats/monthly?date=&subuser=&sort_by_metric=blocks&sort_by_direction=desc&limit=5&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats", "monthly" ], "query": [ { "description": "(Required) The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD", "key": "date", "value": "" }, { "description": "A substring search of your subusers.", "key": "subuser", "value": "" }, { "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'", "key": "sort_by_metric", "value": "blocks" }, { "description": "The direction you want to sort.", "key": "sort_by_direction", "value": "desc" }, { "description": "Optional field to limit the number of results returned.", "key": "limit", "value": "5" }, { "description": "Optional beginning point in the list to retrieve from.", "key": "offset", "value": "0" } ] }, "description": "**This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range.**\n\nWhen using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics:\n`bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_report_drops`, `spam_reports`, or `unsubscribe_drops`." }, "response": [ { "id": "da9f4e03-bed0-4701-aa80-83922f2ec76f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats/monthly?date=&subuser=&sort_by_metric=blocks&sort_by_direction=desc&limit=5&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats", "monthly" ], "query": [ { "description": "(Required) The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD", "key": "date", "value": "" }, { "description": "A substring search of your subusers.", "key": "subuser", "value": "" }, { "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'", "key": "sort_by_metric", "value": "blocks" }, { "description": "The direction you want to sort.", "key": "sort_by_direction", "value": "desc" }, { "description": "Optional field to limit the number of results returned.", "key": "limit", "value": "5" }, { "description": "Optional beginning point in the list to retrieve from.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"date\": \"\",\n \"stats\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-da9f4e03-bed0-4701-aa80-83922f2ec76f" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-f3e0f62e-1f0b-4948-9666-2c7f9f9cb02d" } ], "id": "42d33762-9e55-4196-9428-621f0fc59485", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-42d33762-9e55-4196-9428-621f0fc59485" }, { "name": "sums", "item": [ { "name": "Retrieve the totals for each email statistic metric for all subusers.", "id": "28cc3fe4-103d-4aac-a105-781ebef77c19", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats/sums?sort_by_direction=desc&start_date=&end_date=&limit=5&offset=0&aggregated_by=&sort_by_metric=delivered", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats", "sums" ], "query": [ { "description": "The direction you want to sort. ", "key": "sort_by_direction", "value": "desc" }, { "description": "(Required) The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.", "key": "end_date", "value": "" }, { "description": "Limits the number of results returned per page.", "key": "limit", "value": "5" }, { "description": "The point in the list to begin retrieving results from.", "key": "offset", "value": "0" }, { "description": "How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.", "key": "aggregated_by", "value": "" }, { "description": "The metric that you want to sort by. Must be a single metric.", "key": "sort_by_metric", "value": "delivered" } ] }, "description": "**This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.**" }, "response": [ { "id": "2ad17c69-b717-4254-8651-47775fef533d", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats/sums?sort_by_direction=desc&start_date=&end_date=&limit=5&offset=0&aggregated_by=&sort_by_metric=delivered", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats", "sums" ], "query": [ { "description": "The direction you want to sort. ", "key": "sort_by_direction", "value": "desc" }, { "description": "(Required) The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.", "key": "end_date", "value": "" }, { "description": "Limits the number of results returned per page.", "key": "limit", "value": "5" }, { "description": "The point in the list to begin retrieving results from.", "key": "offset", "value": "0" }, { "description": "How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.", "key": "aggregated_by", "value": "" }, { "description": "The metric that you want to sort by. Must be a single metric.", "key": "sort_by_metric", "value": "delivered" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"date\": \"\",\n \"stats\": [\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n },\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-2ad17c69-b717-4254-8651-47775fef533d" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-28cc3fe4-103d-4aac-a105-781ebef77c19" } ], "id": "293b315e-bdaa-4d78-80a1-685a2cb4865d", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-293b315e-bdaa-4d78-80a1-685a2cb4865d" }, { "name": "Retrieve email statistics for your subusers.", "id": "595e89a8-a159-438b-bf9c-f131893fda13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats?limit=&offset=&aggregated_by=day&subusers=&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats" ], "query": [ { "description": "Limits the number of results returned per page.", "key": "limit", "value": "" }, { "description": "The point in the list to begin retrieving results from.", "key": "offset", "value": "" }, { "description": "How to group the statistics. Must be either \"day\", \"week\", or \"month\".", "key": "aggregated_by", "value": "day" }, { "description": "(Required) The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.", "key": "subusers", "value": "" }, { "description": "(Required) The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "The end date of the statistics to retrieve. Defaults to today.", "key": "end_date", "value": "" } ] }, "description": "**This endpoint allows you to retrieve the email statistics for the given subusers.**\n\nYou may retrieve statistics for up to 10 different subusers by including an additional _subusers_ parameter for each additional subuser." }, "response": [ { "id": "3cc5a1e9-1bc3-4fd8-9d09-e011174a6e9c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers/stats?limit=&offset=&aggregated_by=day&subusers=&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers", "stats" ], "query": [ { "description": "Limits the number of results returned per page.", "key": "limit", "value": "" }, { "description": "The point in the list to begin retrieving results from.", "key": "offset", "value": "" }, { "description": "How to group the statistics. Must be either \"day\", \"week\", or \"month\".", "key": "aggregated_by", "value": "day" }, { "description": "(Required) The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.", "key": "subusers", "value": "" }, { "description": "(Required) The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "The end date of the statistics to retrieve. Defaults to today.", "key": "end_date", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n },\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n },\n {\n \"type\": \"\",\n \"metrics\": {\n \"blocks\": \"\",\n \"bounce_drops\": \"\",\n \"bounces\": \"\",\n \"clicks\": \"\",\n \"deferred\": \"\",\n \"delivered\": \"\",\n \"invalid_emails\": \"\",\n \"opens\": \"\",\n \"processed\": \"\",\n \"requests\": \"\",\n \"spam_report_drops\": \"\",\n \"spam_reports\": \"\",\n \"unique_clicks\": \"\",\n \"unique_opens\": \"\",\n \"unsubscribe_drops\": \"\",\n \"unsubscribes\": \"\"\n },\n \"name\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-3cc5a1e9-1bc3-4fd8-9d09-e011174a6e9c" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-595e89a8-a159-438b-bf9c-f131893fda13" } ], "id": "04af61fb-2aff-4950-8d02-fbfad8e92f49", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-04af61fb-2aff-4950-8d02-fbfad8e92f49" }, { "name": "List all Subusers", "id": "85e60522-e464-4828-86db-22558a4c29a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/subusers?username=&limit=®ion=eu&include_region=false&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ], "query": [ { "description": "The username of this subuser.", "key": "username", "value": "" }, { "description": "`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.", "key": "limit", "value": "" }, { "description": "Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter `all`. Users who are not pinned to a region will be displayed as `global`.", "key": "region", "value": "eu" }, { "description": "Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response.", "key": "include_region", "value": "false" }, { "description": "The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0` represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the `offset` to the page size as determined by `limit`. Use multiples of the page size as your `offset` to request further consecutive pages. E.g. assume your page size is set to `10`. An `offset` of `10` requests the second page, an `offset` of `20` requests the third page and so on, provided there are sufficiently many items in your list.", "key": "offset", "value": "0" } ] }, "description": "**This endpoint allows you to retrieve a paginated list of all your subusers.**\n\nYou can use the `username` query parameter to filter the list for specific subusers.\n\nYou can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items." }, "response": [ { "id": "49d8879e-a658-4101-8de8-65a617104524", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers?username=&limit=®ion=eu&include_region=false&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ], "query": [ { "description": "The username of this subuser.", "key": "username", "value": "" }, { "description": "`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.", "key": "limit", "value": "" }, { "description": "Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter `all`. Users who are not pinned to a region will be displayed as `global`.", "key": "region", "value": "eu" }, { "description": "Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response.", "key": "include_region", "value": "false" }, { "description": "The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0` represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the `offset` to the page size as determined by `limit`. Use multiples of the page size as your `offset` to request further consecutive pages. E.g. assume your page size is set to `10`. An `offset` of `10` requests the second page, an `offset` of `20` requests the third page and so on, provided there are sufficiently many items in your list.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"disabled\": \"\",\n \"id\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"region\": \"eu\"\n },\n {\n \"disabled\": \"\",\n \"id\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"region\": \"global\"\n }\n]", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-49d8879e-a658-4101-8de8-65a617104524" }, { "id": "cd35c099-97e9-4b2c-a16b-c77d166bd481", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/subusers?username=&limit=®ion=eu&include_region=false&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ], "query": [ { "description": "The username of this subuser.", "key": "username", "value": "" }, { "description": "`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.", "key": "limit", "value": "" }, { "description": "Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter `all`. Users who are not pinned to a region will be displayed as `global`.", "key": "region", "value": "eu" }, { "description": "Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response.", "key": "include_region", "value": "false" }, { "description": "The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0` represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the `offset` to the page size as determined by `limit`. Use multiples of the page size as your `offset` to request further consecutive pages. E.g. assume your page size is set to `10`. An `offset` of `10` requests the second page, an `offset` of `20` requests the third page and so on, provided there are sufficiently many items in your list.", "key": "offset", "value": "0" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-cd35c099-97e9-4b2c-a16b-c77d166bd481" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-85e60522-e464-4828-86db-22558a4c29a7" }, { "name": "Create Subuser", "id": "6925a2fe-5e92-4913-8747-571a9b933b2c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] }, "description": "**This endpoint allows you to create a new subuser.**" }, "response": [ { "id": "59eaf720-3a44-4a09-8dd8-779e0295aff5", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"username\": \"\",\n \"user_id\": \"\",\n \"email\": \"\",\n \"credit_allocation\": {\n \"type\": \"\"\n },\n \"region\": \"global\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-59eaf720-3a44-4a09-8dd8-779e0295aff5" }, { "id": "efa6f0a1-9b49-479c-9c58-5f7deda825ce", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-efa6f0a1-9b49-479c-9c58-5f7deda825ce" }, { "id": "4bbb15bd-4485-4c39-86fa-6f4efde3f910", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-4bbb15bd-4485-4c39-86fa-6f4efde3f910" }, { "id": "8a67a197-44a6-4c67-86ae-2a521353d10d", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-8a67a197-44a6-4c67-86ae-2a521353d10d" }, { "id": "4d09821f-42cd-49a5-b481-9b7537de8b85", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"ips\": [\n \"\",\n \"\"\n ],\n \"region\": \"eu\",\n \"include_region\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/subusers", "host": [ "{{baseUrl}}" ], "path": [ "v3", "subusers" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-4d09821f-42cd-49a5-b481-9b7537de8b85" } ], "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:50.000Z", "uid": "35240-6925a2fe-5e92-4913-8747-571a9b933b2c" } ], "id": "841f97d7-2536-4fe4-9d70-f39ee2d9672b", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-841f97d7-2536-4fe4-9d70-f39ee2d9672b" } ], "id": "67287ca7-2e8e-413a-8413-82e604807ddf", "createdAt": "2026-06-05T15:17:49.000Z", "updatedAt": "2026-06-05T15:17:49.000Z", "uid": "35240-67287ca7-2e8e-413a-8413-82e604807ddf" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sendgrid.com" } ] }