{ "info": { "_postman_id": "7543363d-290a-4111-93d5-b5ba2a919ec5", "name": "Twilio SendGrid Legacy Marketing Campaigns Contacts API", "description": "The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns' [Contacts API](https://docs.sendgrid.com/api-reference/contacts/), [Lists API](https://docs.sendgrid.com/api-reference/lists/), and [Segments API](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/) to manage your contacts.\n\nSee [**Migrating from Legacy Marketing Campaigns**](https://docs.sendgrid.com/ui/sending-email/migrating-from-legacy-marketing-campaigns) 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:20.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "lastUpdatedBy": "35240", "uid": "35240-7543363d-290a-4111-93d5-b5ba2a919ec5" }, "item": [ { "name": "v3", "item": [ { "name": "contactdb", "item": [ { "name": "custom_fields", "item": [ { "name": "{custom_field_id}", "item": [ { "name": "Retrieve a Custom Field", "id": "8f0e5f3a-59dd-42a9-923a-94ab5f7e51cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "id": "b2c4fe28-45c4-427d-abbf-41ff5f6c8c14", "key": "custom_field_id", "value": "", "description": "(Required) The ID of the custom field that you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a custom field by ID.**" }, "response": [ { "id": "b8afad31-54d2-4372-a183-262ee661960c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b8afad31-54d2-4372-a183-262ee661960c" }, { "id": "b0fb693d-b4a0-4be8-a863-cfb3bd444ec8", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b0fb693d-b4a0-4be8-a863-cfb3bd444ec8" }, { "id": "cebba42f-58d2-44f2-b2b4-1ae5418cf540", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-cebba42f-58d2-44f2-b2b4-1ae5418cf540" }, { "id": "e6ab5e04-a9ad-4374-bf07-2864d25c6f38", "name": "The `custom_field_id` does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e6ab5e04-a9ad-4374-bf07-2864d25c6f38" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-8f0e5f3a-59dd-42a9-923a-94ab5f7e51cf" }, { "name": "Delete a Custom Field", "id": "431fa0c8-b4d4-4239-ac3f-a397d6bdccac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "id": "1169d1ad-9979-489f-82df-c67707b3c57b", "key": "custom_field_id", "value": "", "description": "(Required) The ID of the custom field that you want to retrieve." } ] }, "description": "**This endpoint allows you to delete a custom field by ID.**" }, "response": [ { "id": "cbab8199-5021-421b-981e-37c5dcb2ee24", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "status": "Accepted", "code": 202, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-cbab8199-5021-421b-981e-37c5dcb2ee24" }, { "id": "f0e8afb2-2777-4edb-91c5-e4fe35668dd8", "name": "The `custom_field_id` is not valid", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f0e8afb2-2777-4edb-91c5-e4fe35668dd8" }, { "id": "15a91f7b-89e3-4590-b9ba-86e69d5eef04", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-15a91f7b-89e3-4590-b9ba-86e69d5eef04" }, { "id": "01d12214-dd86-4776-8b0f-65b0c5617ff8", "name": "The `custom_field_id` does not exist", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-01d12214-dd86-4776-8b0f-65b0c5617ff8" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-431fa0c8-b4d4-4239-ac3f-a397d6bdccac" } ], "id": "60ef6f44-8b87-4e27-b48f-ce5fdeb13384", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-60ef6f44-8b87-4e27-b48f-ce5fdeb13384" }, { "name": "Create a Custom Field", "id": "01a61597-eb9e-4ae7-a90e-74df24e40b16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] }, "description": "**This endpoint allows you to create a custom field.**\n\n**You can create up to 120 custom fields.**" }, "response": [ { "id": "300c97c5-1e8a-4db9-9c76-3fc00292215c", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-300c97c5-1e8a-4db9-9c76-3fc00292215c" }, { "id": "258e2408-bce6-4da1-9c0b-6f36cac8cf7b", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-258e2408-bce6-4da1-9c0b-6f36cac8cf7b" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-01a61597-eb9e-4ae7-a90e-74df24e40b16" }, { "name": "Retrieve all custom fields", "id": "2c6a803d-f2e9-4899-bd99-95818f1b044b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] }, "description": "**This endpoint allows you to retrieve all custom fields.**" }, "response": [ { "id": "de3b05b3-6b05-431e-8582-95495a9c657f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-de3b05b3-6b05-431e-8582-95495a9c657f" }, { "id": "ebe557f6-d6ff-424b-b312-5a33495b3d80", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/custom_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "custom_fields" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ebe557f6-d6ff-424b-b312-5a33495b3d80" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-2c6a803d-f2e9-4899-bd99-95818f1b044b" } ], "id": "6d357595-360f-4e64-9a1e-d69932782929", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-6d357595-360f-4e64-9a1e-d69932782929" }, { "name": "lists", "item": [ { "name": "{list_id}", "item": [ { "name": "recipients", "item": [ { "name": "{recipient_id}", "item": [ { "name": "Add a Single Recipient to a List", "id": "88f3002c-2096-4b54-a795-ce7fe1cc3ad2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "id": "fa2a88be-0763-4b5a-9498-aaf3cadf54cf", "key": "list_id", "value": "", "description": "(Required) The ID of the list that you want to add the recipient to." }, { "id": "1b605ce4-abc6-49e9-be6a-98c41ce2a662", "key": "recipient_id", "value": "", "description": "(Required) The ID of the recipient you are adding to the list." } ] }, "description": "**This endpoint allows you to add a single recipient to a list.**" }, "response": [ { "id": "a0a8b561-4614-4e98-ab26-4d507816bf3a", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"nullable\": true\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a0a8b561-4614-4e98-ab26-4d507816bf3a" }, { "id": "e3f60589-d968-4ef8-b9c9-66fd3e1c7ace", "name": "Input failed validation", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e3f60589-d968-4ef8-b9c9-66fd3e1c7ace" }, { "id": "133b1542-079e-4adb-9af0-831ea66cfd74", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-133b1542-079e-4adb-9af0-831ea66cfd74" }, { "id": "0a2ca561-27c6-4c22-885a-1cc11bffe202", "name": "Input failed validation", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0a2ca561-27c6-4c22-885a-1cc11bffe202" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-88f3002c-2096-4b54-a795-ce7fe1cc3ad2" }, { "name": "Delete a Single Recipient from a Single List", "id": "b68e2eba-5cd4-4df5-bb58-03d798a9c930", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "id": "f34bcd08-3d4c-4164-bd40-6ab37a33af41", "key": "list_id", "value": "", "description": "(Required) The ID of the list that you want to add the recipient to." }, { "id": "86358985-bbea-40fd-9bda-27b3514dc8a6", "key": "recipient_id", "value": "", "description": "(Required) The ID of the recipient you are adding to the list." } ] }, "description": "**This endpoint allows you to delete a single recipient from a list.**" }, "response": [ { "id": "7dd99f75-5a23-4893-9398-cd4380fd49c2", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7dd99f75-5a23-4893-9398-cd4380fd49c2" }, { "id": "6df51ecb-b4bc-4376-ab21-046d5a9c5593", "name": "Input failed validation", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-6df51ecb-b4bc-4376-ab21-046d5a9c5593" }, { "id": "4b02d65e-1812-4fb6-9ca7-4644be11e78d", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-4b02d65e-1812-4fb6-9ca7-4644be11e78d" }, { "id": "e63eb328-4ea2-48b3-afc6-48fe366147e3", "name": "Returned if list_id or recipient_id does not exist", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients", ":recipient_id" ], "variable": [ { "key": "list_id" }, { "key": "recipient_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e63eb328-4ea2-48b3-afc6-48fe366147e3" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b68e2eba-5cd4-4df5-bb58-03d798a9c930" } ], "id": "3bc3f1b1-5d60-46a7-8660-c28d28ece27e", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-3bc3f1b1-5d60-46a7-8660-c28d28ece27e" }, { "name": "Retrieve all recipients on a List", "id": "04d5f9ee-beb8-47b5-b2fe-6f7ef0650d64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "query": [ { "description": "Page index of first recipient to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ], "variable": [ { "id": "1bc68cb3-f8ad-430c-a8ba-e7c1034c1f9b", "key": "list_id", "value": "", "description": "(Required) The id of the list of recipients you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve all recipients on the list with the given ID.**" }, "response": [ { "id": "b3258d7e-0344-4ebf-a8ef-6b01e73a7d8c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "query": [ { "description": "Page index of first recipient to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ], "variable": [ { "key": "list_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": [\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b3258d7e-0344-4ebf-a8ef-6b01e73a7d8c" }, { "id": "d6a2e18a-d4e3-4b86-b20a-778440b6b71e", "name": "Input failed validation", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "query": [ { "description": "Page index of first recipient to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d6a2e18a-d4e3-4b86-b20a-778440b6b71e" }, { "id": "6fc96cf5-9acb-4729-b245-a40d29499853", "name": "Returned if `list_id` does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "query": [ { "description": "Page index of first recipient to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ], "variable": [ { "key": "list_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-6fc96cf5-9acb-4729-b245-a40d29499853" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-04d5f9ee-beb8-47b5-b2fe-6f7ef0650d64" }, { "name": "Add Multiple Recipients to a List", "id": "386c0e3c-3377-4990-9e62-d48b6579a71a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists/:list_id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "variable": [ { "id": "9c8e0df2-4e49-475e-bcf8-c1b5a2339d8b", "key": "list_id", "value": "", "description": "(Required) The id of the list of recipients you want to retrieve." } ] }, "description": "**This endpoint allows you to add multiple recipients to a list.**\n\nAdds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs (base64-encoded email addresses) should be passed exactly as they are returned from recipient endpoints." }, "response": [ { "id": "f4363905-63d4-4c46-a58e-3cd7f0dbaa03", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists/:list_id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "variable": [ { "key": "list_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"nullable\": true\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f4363905-63d4-4c46-a58e-3cd7f0dbaa03" }, { "id": "378e221c-13db-4d8a-a3b9-5c81d046f44b", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists/:list_id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-378e221c-13db-4d8a-a3b9-5c81d046f44b" }, { "id": "83444db2-8cee-493e-a8b7-fa38f28c945b", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists/:list_id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-83444db2-8cee-493e-a8b7-fa38f28c945b" }, { "id": "e98e27f5-2f43-4871-acae-7ea87e133b72", "name": "Returned if `list_id` does not exist", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists/:list_id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id", "recipients" ], "variable": [ { "key": "list_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e98e27f5-2f43-4871-acae-7ea87e133b72" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-386c0e3c-3377-4990-9e62-d48b6579a71a" } ], "id": "fad86722-60e6-4970-9b71-20a5cfdf7ef8", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fad86722-60e6-4970-9b71-20a5cfdf7ef8" }, { "name": "Retrieve a single list", "id": "5e00df50-433b-46d4-893d-2c1e70d78214", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "id": "d93b0c83-dcb7-4929-94fa-81087f7f31a4", "key": "list_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to retrieve a single recipient list.**" }, "response": [ { "id": "b3c6a551-3acc-4520-8c1d-124b61f80eff", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b3c6a551-3acc-4520-8c1d-124b61f80eff" }, { "id": "15a9eba0-a5fd-4752-bc2c-a9451d77b590", "name": "Provided `list_id` is not valid", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-15a9eba0-a5fd-4752-bc2c-a9451d77b590" }, { "id": "e9cc36b2-c3c3-422f-acc4-7f2f6c9587a2", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e9cc36b2-c3c3-422f-acc4-7f2f6c9587a2" }, { "id": "ecd2d7b0-8ee2-4c39-aa22-aa1fd7dc01ab", "name": "Provided `list_id` does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ecd2d7b0-8ee2-4c39-aa22-aa1fd7dc01ab" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-5e00df50-433b-46d4-893d-2c1e70d78214" }, { "name": "Update a List", "id": "0e8e77e9-b865-4b45-a614-362a99d6e948", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "id": "b4bcf60b-2711-45d8-b4f5-bffe78b203a9", "key": "list_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to update the name of one of your recipient lists.**" }, "response": [ { "id": "1a9db309-156a-4e9e-a294-1cf29af9de5e", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-1a9db309-156a-4e9e-a294-1cf29af9de5e" }, { "id": "13d7777c-77be-4081-ab21-8b7935947606", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-13d7777c-77be-4081-ab21-8b7935947606" }, { "id": "4c14747b-257f-46cd-b095-2961245ffb28", "name": "Returned if `list_id` does not exist", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "variable": [ { "key": "list_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-4c14747b-257f-46cd-b095-2961245ffb28" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0e8e77e9-b865-4b45-a614-362a99d6e948" }, { "name": "Delete a List", "id": "721453ae-24fc-4441-9ac2-caf5d6c21088", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id?delete_contacts=false", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "query": [ { "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.", "key": "delete_contacts", "value": "false" } ], "variable": [ { "id": "50af81dd-e3b2-4203-8703-dca17ad8b2e6", "key": "list_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to delete a specific recipient list with the given ID.**" }, "response": [ { "id": "7683a8f1-9103-4611-aa02-6ea25da6a628", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id?delete_contacts=false", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "query": [ { "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.", "key": "delete_contacts", "value": "false" } ], "variable": [ { "key": "list_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"nullable\": true\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7683a8f1-9103-4611-aa02-6ea25da6a628" }, { "id": "a7e5f203-d2ce-4f06-b7f1-6e73e910086e", "name": "Returned if `list_id` or `delete_contacts` are not valid", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id?delete_contacts=false", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "query": [ { "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.", "key": "delete_contacts", "value": "false" } ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a7e5f203-d2ce-4f06-b7f1-6e73e910086e" }, { "id": "fd018b09-d723-4358-add2-c9f87942cb52", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id?delete_contacts=false", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "query": [ { "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.", "key": "delete_contacts", "value": "false" } ], "variable": [ { "key": "list_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fd018b09-d723-4358-add2-c9f87942cb52" }, { "id": "a655fe86-6cbe-42a4-acb2-21a2c1ea1420", "name": "Returned if `list_id` does not exist", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists/:list_id?delete_contacts=false", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists", ":list_id" ], "query": [ { "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.", "key": "delete_contacts", "value": "false" } ], "variable": [ { "key": "list_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a655fe86-6cbe-42a4-acb2-21a2c1ea1420" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-721453ae-24fc-4441-9ac2-caf5d6c21088" } ], "id": "88794f41-76ad-44e6-a291-aa5a0663a48d", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-88794f41-76ad-44e6-a291-aa5a0663a48d" }, { "name": "Create a List", "id": "2bf817d9-82e9-4ee0-ad27-b2353810abae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] }, "description": "**This endpoint allows you to create a list for your recipients.**" }, "response": [ { "id": "d7a9f6aa-1fb2-43db-9330-8896f92d7530", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d7a9f6aa-1fb2-43db-9330-8896f92d7530" }, { "id": "de73f2cf-af87-4c3e-a796-f1b6bce348a8", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-de73f2cf-af87-4c3e-a796-f1b6bce348a8" }, { "id": "98305e36-8bb3-4fb9-8ba9-e2088b34297d", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-98305e36-8bb3-4fb9-8ba9-e2088b34297d" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-2bf817d9-82e9-4ee0-ad27-b2353810abae" }, { "name": "Retrieve all lists", "id": "9c8a1fb6-d6df-4e12-bd72-2976c3477d3b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] }, "description": "**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.**" }, "response": [ { "id": "720b5b3e-203e-47a5-be32-44e5357f12b0", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"lists\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-720b5b3e-203e-47a5-be32-44e5357f12b0" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9c8a1fb6-d6df-4e12-bd72-2976c3477d3b" }, { "name": "Delete Multiple lists", "id": "db22d788-3ca3-4748-84ba-1ef5df8791e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] }, "description": "**This endpoint allows you to delete multiple recipient lists.**" }, "response": [ { "id": "2a2d6d4b-0cc5-4054-b627-ce6c4c6dc6bb", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "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/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-2a2d6d4b-0cc5-4054-b627-ce6c4c6dc6bb" }, { "id": "e1b3a88c-c37e-4a79-8b4f-051b490339b8", "name": "All list ids are not valid", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e1b3a88c-c37e-4a79-8b4f-051b490339b8" }, { "id": "51b960a3-a253-4552-bf17-41f1bec919b4", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "lists" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-51b960a3-a253-4552-bf17-41f1bec919b4" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-db22d788-3ca3-4748-84ba-1ef5df8791e3" } ], "id": "0ca1a28b-d7f2-478e-abc2-e4a618d8ee56", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0ca1a28b-d7f2-478e-abc2-e4a618d8ee56" }, { "name": "recipients", "item": [ { "name": "{recipient_id}", "item": [ { "name": "lists", "item": [ { "name": "Retrieve the lists that a recipient is on", "id": "82988205-d4bb-4fe9-a34e-0efdd2071c9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id", "lists" ], "variable": [ { "id": "564376d3-8b15-4962-aceb-60ce22506684", "key": "recipient_id", "value": "", "description": "(Required) The ID of the recipient for whom you are retrieving lists." } ] }, "description": "**This endpoint allows you to retrieve the lists that a given recipient belongs to.**\n\nEach recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to." }, "response": [ { "id": "ac049032-1fdc-4f1e-b127-93880055e637", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id", "lists" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"lists\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"recipient_count\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ac049032-1fdc-4f1e-b127-93880055e637" }, { "id": "575041a3-31aa-41cb-9066-d9ae2729ddb4", "name": "Returned if `recipient_id` is not valid", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id", "lists" ], "variable": [ { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-575041a3-31aa-41cb-9066-d9ae2729ddb4" }, { "id": "9844c203-faa6-499d-a8f4-f427f4045dd6", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id", "lists" ], "variable": [ { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9844c203-faa6-499d-a8f4-f427f4045dd6" }, { "id": "bb0e9352-788b-4938-89bc-190869db79b6", "name": "Returned if a record for the recipient id does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id/lists", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id", "lists" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-bb0e9352-788b-4938-89bc-190869db79b6" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-82988205-d4bb-4fe9-a34e-0efdd2071c9d" } ], "id": "cb985024-a212-477a-ada5-826f79099e81", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-cb985024-a212-477a-ada5-826f79099e81" }, { "name": "Retrieve a single recipient", "id": "7725348c-ed8f-450a-8632-d1acf1e15203", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "id": "b2050583-0316-41ef-9c6b-b18fe5d2a8b9", "key": "recipient_id", "value": "", "description": "(Required) The ID of the recipient that you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a single recipient by ID from your contact database.**" }, "response": [ { "id": "16fea2e0-045a-4864-bf52-62e9f903d916", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-16fea2e0-045a-4864-bf52-62e9f903d916" }, { "id": "d41f790e-58a0-4cb9-bcf3-1ae3e4ed0ba6", "name": "Returned if `recipient_id` is not valid", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d41f790e-58a0-4cb9-bcf3-1ae3e4ed0ba6" }, { "id": "0044a516-3378-480c-8a17-c35371df9cd8", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0044a516-3378-480c-8a17-c35371df9cd8" }, { "id": "f3fd59fd-8304-41ae-8dd7-0f013f22d5cc", "name": "A record for that recipient id does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f3fd59fd-8304-41ae-8dd7-0f013f22d5cc" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7725348c-ed8f-450a-8632-d1acf1e15203" }, { "name": "Delete a Recipient", "id": "8fd770e6-4372-432a-91aa-ba40f7cdd460", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "id": "c8127601-ed1c-4a34-8731-0e6a5fd25435", "key": "recipient_id", "value": "", "description": "(Required) The ID of the recipient that you want to retrieve." } ] }, "description": "**This endpoint allows you to delete a single recipient with the given ID from your contact database.**\n\n> Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law." }, "response": [ { "id": "01d3e826-3c44-46aa-b10a-402eadd9b034", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-01d3e826-3c44-46aa-b10a-402eadd9b034" }, { "id": "20f6d066-29cf-416f-a6af-2c36c19c1411", "name": "Returned if `recipient_id` is not valid", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-20f6d066-29cf-416f-a6af-2c36c19c1411" }, { "id": "3606b85f-3f23-4bf7-b9c5-10cbb9949ad3", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-3606b85f-3f23-4bf7-b9c5-10cbb9949ad3" }, { "id": "afdcec83-3577-472e-bca8-dfcc79c38b00", "name": "A record for that recipient id does not exist", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/:recipient_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", ":recipient_id" ], "variable": [ { "key": "recipient_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-afdcec83-3577-472e-bca8-dfcc79c38b00" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-8fd770e6-4372-432a-91aa-ba40f7cdd460" } ], "id": "22dd6438-5c77-4706-a996-3c2085eb33dd", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-22dd6438-5c77-4706-a996-3c2085eb33dd" }, { "name": "billable_count", "item": [ { "name": "Retrieve the count of billable recipients", "id": "81879ebd-d503-41fd-a449-d4a4bda60e74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/billable_count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "billable_count" ] }, "description": "**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.**\n\nYou are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value." }, "response": [ { "id": "56538f38-d6ae-4046-8ee7-d7d27888b2b6", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/billable_count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "billable_count" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-56538f38-d6ae-4046-8ee7-d7d27888b2b6" }, { "id": "b13a78b4-27a1-474e-90d1-44343b6ea510", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/billable_count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "billable_count" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b13a78b4-27a1-474e-90d1-44343b6ea510" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-81879ebd-d503-41fd-a449-d4a4bda60e74" } ], "id": "d8802200-4a62-4186-a25f-c203860c63b9", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d8802200-4a62-4186-a25f-c203860c63b9" }, { "name": "count", "item": [ { "name": "Retrieve a Count of Recipients", "id": "0b5ff9bd-be45-4ea7-a5ca-458e4b07dda9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "count" ] }, "description": "**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**" }, "response": [ { "id": "0c429ca1-c51a-4571-a959-7b794e860936", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "count" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0c429ca1-c51a-4571-a959-7b794e860936" }, { "id": "d940d9fb-7f0d-4bae-b725-e203c85e85ac", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/count", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "count" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d940d9fb-7f0d-4bae-b725-e203c85e85ac" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0b5ff9bd-be45-4ea7-a5ca-458e4b07dda9" } ], "id": "db14ca55-d24d-4a88-a54c-2338838e7338", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-db14ca55-d24d-4a88-a54c-2338838e7338" }, { "name": "search", "item": [ { "name": "Search recipients", "id": "ff25a930-ec69-417a-aa81-445e1e31a185", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search?{field_name}=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ], "query": [ { "key": "{field_name}", "value": "" } ] }, "description": "**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.**\n\nfield_name:\n\n* is a variable that is substituted for your actual custom field name from your recipient.\n* Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200)\n* If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert\nyour epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to\nMon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through\nMon, 02 Feb 2015 23:59:59 GMT." }, "response": [ { "id": "ead6a595-f8df-492b-9bc1-58321059d417", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search?{field_name}=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ], "query": [ { "key": "{field_name}", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": [\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ead6a595-f8df-492b-9bc1-58321059d417" }, { "id": "e6a4cdbc-5471-4fd6-9cfe-bfef0e4f87fc", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search?{field_name}=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ], "query": [ { "key": "{field_name}", "value": "" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e6a4cdbc-5471-4fd6-9cfe-bfef0e4f87fc" }, { "id": "e5899bd3-1604-4d9b-af48-09646cdae00f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search?{field_name}=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ], "query": [ { "key": "{field_name}", "value": "" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e5899bd3-1604-4d9b-af48-09646cdae00f" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ff25a930-ec69-417a-aa81-445e1e31a185" }, { "name": "Search recipients", "id": "c4955d10-ee69-4184-9fde-280218c22b0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"gt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ] }, "description": "Search using segment conditions without actually creating a segment.\nBody contains a JSON object with `conditions`, a list of conditions as described below, and an optional `list_id`, which is a valid list ID for a list to limit the search on.\n\nValid operators for create and update depend on the type of the field for which you are searching.\n\n- Dates:\n - `\"eq\"`, `\"ne\"`, `\"lt\"` (before), `\"gt\"` (after)\n - You may use MM/DD/YYYY for day granularity or an epoch for second granularity.\n - `\"empty\"`, `\"not_empty\"`\n - `\"is within\"`\n - You may use an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format or the # of days.\n- Text: `\"contains\"`, `\"eq\"` (is - matches the full field), `\"ne\"` (is not - matches any field where the entire field is not the condition value), `\"empty\"`, `\"not_empty\"`\n- Numbers: `\"eq\"`, `\"lt\"`, `\"gt\"`, `\"empty\"`, `\"not_empty\"`\n- Email Clicks and Opens: `\"eq\"` (opened), `\"ne\"` (not opened)\n\nField values must all be a string.\n\nSearch conditions using `\"eq\"` or `\"ne\"` for email clicks and opens should provide a \"field\" of either `clicks.campaign_identifier` or `opens.campaign_identifier`.\n\nThe condition value should be a string containing the id of a completed campaign.\n\nSearch conditions list may contain multiple conditions, joined by an `\"and\"` or `\"or\"` in the `\"and_or\"` field.\n\nThe first condition in the conditions list must have an empty `\"and_or\"`, and subsequent conditions must all specify an `\"and_or\"`." }, "response": [ { "id": "7cdc38d6-adea-4d99-b021-fe32b56d2759", "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 \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"gt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": [\n {\n \"created_at\": \"\",\n \"email\": \"\",\n \"id\": \"\",\n \"last_emailed\": \"\",\n \"last_clicked\": \"\",\n \"last_opened\": \"\",\n \"custom_fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"updated_at\": \"\",\n \"first_name\": \"\"\n },\n {\n \"created_at\": \"\",\n \"email\": \"\",\n \"id\": \"\",\n \"last_emailed\": \"\",\n \"last_clicked\": \"\",\n \"last_opened\": \"\",\n \"custom_fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"updated_at\": \"\",\n \"first_name\": \"\"\n }\n ],\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7cdc38d6-adea-4d99-b021-fe32b56d2759" }, { "id": "7eb54c0f-587f-4ceb-97e1-ddcf91ed669e", "name": "response", "originalRequest": { "method": "POST", "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 \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"gt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients/search", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7eb54c0f-587f-4ceb-97e1-ddcf91ed669e" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c4955d10-ee69-4184-9fde-280218c22b0b" } ], "id": "619dff5d-2ac3-4ecc-b332-3cc01203f137", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-619dff5d-2ac3-4ecc-b332-3cc01203f137" }, { "name": "Add recipients", "id": "989724fa-a8e9-43d4-b596-a5a1b6450cf2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] }, "description": "**This endpoint allows you to add a Marketing Campaigns recipient.**\n\nYou can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides.\n\nThe rate limit is three requests every 2 seconds. You can upload 1000 contacts per request. So the maximum upload rate is 1500 recipients per second." }, "response": [ { "id": "0282f6d0-926c-41b5-895e-1d17aae061b5", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_count\": 0,\n \"new_count\": 0,\n \"persisted_recipients\": [],\n \"updated_count\": 0,\n \"errors\": [\n {\n \"message\": \"\",\n \"error_indices\": [\n \"\",\n \"\"\n ]\n },\n {\n \"message\": \"\",\n \"error_indices\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0282f6d0-926c-41b5-895e-1d17aae061b5" }, { "id": "4accc845-79d5-4de8-bb84-dec8132a8a15", "name": "The request body is not valid json", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-4accc845-79d5-4de8-bb84-dec8132a8a15" }, { "id": "73d18ef8-d9cc-456a-ac7e-8a4f453aedc6", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"age\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-73d18ef8-d9cc-456a-ac7e-8a4f453aedc6" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-989724fa-a8e9-43d4-b596-a5a1b6450cf2" }, { "name": "Update Recipient", "id": "67241002-53b6-4c1c-a1df-59deacf5a21e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n },\n {\n \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] }, "description": "**This endpoint allows you to update one or more recipients.**\n\nThe body of an API call to this endpoint must include an array of one or more recipient objects.\n\nIt is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides." }, "response": [ { "id": "0a2b7a5b-dc71-43ea-9feb-8b631102bcd4", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n },\n {\n \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_count\": 0,\n \"new_count\": 0,\n \"persisted_recipients\": [],\n \"updated_count\": 0,\n \"errors\": [\n {\n \"message\": \"\",\n \"error_indices\": [\n \"\",\n \"\"\n ]\n },\n {\n \"message\": \"\",\n \"error_indices\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0a2b7a5b-dc71-43ea-9feb-8b631102bcd4" }, { "id": "001fcdc4-c4ed-40d4-a363-50f9742bdc5f", "name": "The request body is not valid json", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n },\n {\n \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-001fcdc4-c4ed-40d4-a363-50f9742bdc5f" }, { "id": "bba0885d-0036-4fd9-be75-d455647e6609", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n },\n {\n \"email\": \"\",\n \"last_name\": \"\",\n \"first_name\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-bba0885d-0036-4fd9-be75-d455647e6609" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-67241002-53b6-4c1c-a1df-59deacf5a21e" }, { "name": "Delete Recipients", "id": "fd2fa8ab-e40d-4794-84f8-57d55363702a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] }, "description": "**This endpoint allows you to deletes one or more recipients.**\n\nThe body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete." }, "response": [ { "id": "46902494-2077-4553-8d3f-60db1288cd62", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-46902494-2077-4553-8d3f-60db1288cd62" }, { "id": "d0d8aabb-afbd-4289-aaed-cbbc1cd74f4c", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d0d8aabb-afbd-4289-aaed-cbbc1cd74f4c" }, { "id": "ddc311a5-8054-4a75-8f26-05eed8da808b", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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/contactdb/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ddc311a5-8054-4a75-8f26-05eed8da808b" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fd2fa8ab-e40d-4794-84f8-57d55363702a" }, { "name": "Retrieve recipients", "id": "955e1f5c-b23b-410b-ba69-6ff9ffb52a03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ], "query": [ { "description": "Page index of first recipients to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ] }, "description": "**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.**\n\nBatch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of\nthe list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved." }, "response": [ { "id": "a51e6ac3-3322-44c6-8027-ef2f53b15782", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ], "query": [ { "description": "Page index of first recipients to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": []\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a51e6ac3-3322-44c6-8027-ef2f53b15782" }, { "id": "aa03f359-5af0-4542-9772-323f9921ce4e", "name": "Input failed validation", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ], "query": [ { "description": "Page index of first recipients to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-aa03f359-5af0-4542-9772-323f9921ce4e" }, { "id": "1500f93f-3148-4ba8-9be5-e987a71f3532", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "recipients" ], "query": [ { "description": "Page index of first recipients to return (must be a positive integer)", "key": "page", "value": "" }, { "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)", "key": "page_size", "value": "" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-1500f93f-3148-4ba8-9be5-e987a71f3532" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-955e1f5c-b23b-410b-ba69-6ff9ffb52a03" } ], "id": "b73e3e97-4575-477e-bcb2-0ba64229c1bb", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b73e3e97-4575-477e-bcb2-0ba64229c1bb" }, { "name": "reserved_fields", "item": [ { "name": "Retrieve reserved fields", "id": "a7a65bef-5575-4c2d-ba6a-5b9709e2a4ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/reserved_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "reserved_fields" ] }, "description": "**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**" }, "response": [ { "id": "e312b0d2-9454-4354-a367-533cc76934e5", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/reserved_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "reserved_fields" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"reserved_fields\": [\n {\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e312b0d2-9454-4354-a367-533cc76934e5" }, { "id": "9971744d-da5e-4c07-bcd3-422e965b0c86", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/reserved_fields", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "reserved_fields" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9971744d-da5e-4c07-bcd3-422e965b0c86" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a7a65bef-5575-4c2d-ba6a-5b9709e2a4ba" } ], "id": "75151528-b92e-4921-8cd2-ef2824e04693", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-75151528-b92e-4921-8cd2-ef2824e04693" }, { "name": "segments", "item": [ { "name": "{segment_id}", "item": [ { "name": "recipients", "item": [ { "name": "Retrieve recipients on a segment", "id": "a161002f-e808-4a42-a2b6-b59f853ef85c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id", "recipients" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "id": "c1610249-dcd1-4ffa-84ac-a22737182128", "key": "segment_id", "value": "", "description": "(Required) The ID of the segment from which you want to retrieve recipients." } ] }, "description": "**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**" }, "response": [ { "id": "c0b3fd2c-5bf2-4ff9-b2fb-8f89bce8df57", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id", "recipients" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipients\": [\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"recipients\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"date\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"text\",\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_clicked\": \"\",\n \"last_emailed\": \"\",\n \"last_opened\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c0b3fd2c-5bf2-4ff9-b2fb-8f89bce8df57" }, { "id": "37f178fb-f3a6-400b-ae02-6b1a849f3fbd", "name": "Input failed validation", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id", "recipients" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-37f178fb-f3a6-400b-ae02-6b1a849f3fbd" }, { "id": "12a9a637-fec0-473d-8489-71d464310a6a", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id", "recipients" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-12a9a637-fec0-473d-8489-71d464310a6a" }, { "id": "93987469-1375-49e6-8cd0-6f57b8261c77", "name": "The segment_id is not valid or does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id/recipients?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id", "recipients" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-93987469-1375-49e6-8cd0-6f57b8261c77" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a161002f-e808-4a42-a2b6-b59f853ef85c" } ], "id": "62390edc-dc1d-403a-8691-c7dfea6fcabc", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-62390edc-dc1d-403a-8691-c7dfea6fcabc" }, { "name": "Retrieve a segment", "id": "c393f1e1-aafa-435c-8d88-3264f75fdfe6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "id": "a7f46d5e-4128-4be2-b186-0d6275ac6076", "key": "segment_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to retrieve a single segment with the given ID.**" }, "response": [ { "id": "efd91bb6-f5d6-4808-8278-71e2048d9feb", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-efd91bb6-f5d6-4808-8278-71e2048d9feb" }, { "id": "f4c28598-959a-4c9e-96e8-b6a58d8de6ae", "name": "The segment_id is not valid", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f4c28598-959a-4c9e-96e8-b6a58d8de6ae" }, { "id": "9b1685b3-9242-4edb-a0ec-3d7f9d9694b9", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9b1685b3-9242-4edb-a0ec-3d7f9d9694b9" }, { "id": "e61ba9f0-b884-4339-a7aa-107f0c338441", "name": "Returned if `segment_id` does not exist", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-e61ba9f0-b884-4339-a7aa-107f0c338441" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c393f1e1-aafa-435c-8d88-3264f75fdfe6" }, { "name": "Update a segment", "id": "0467071d-aea1-47fd-94d4-eef51acbd377", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"or\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "id": "adb48ae4-7363-4e65-ac33-99c5e6d1ab8e", "key": "segment_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to update a segment.**" }, "response": [ { "id": "5ce07c8f-cb90-45cd-a350-a1a7901b12ac", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"or\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-5ce07c8f-cb90-45cd-a350-a1a7901b12ac" }, { "id": "f3d1177c-693d-42c6-a336-d5a78dbeaacb", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"or\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f3d1177c-693d-42c6-a336-d5a78dbeaacb" }, { "id": "4f620574-f004-410e-baa0-16f7d7a7e91e", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"list_id\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"or\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-4f620574-f004-410e-baa0-16f7d7a7e91e" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-0467071d-aea1-47fd-94d4-eef51acbd377" }, { "name": "Delete a segment", "id": "45696564-adc4-424a-a252-6b1624f47899", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id?delete_contacts=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "query": [ { "description": "True to delete all contacts matching the segment in addition to deleting the segment", "key": "delete_contacts", "value": "" } ], "variable": [ { "id": "3d03ed3e-cf95-4042-8889-d435eee4f49d", "key": "segment_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to delete a segment from your recipients database.**\n\nYou also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment." }, "response": [ { "id": "3c387fd1-90be-4e2c-8ab3-934e833bd688", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id?delete_contacts=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "query": [ { "description": "True to delete all contacts matching the segment in addition to deleting the segment", "key": "delete_contacts", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-3c387fd1-90be-4e2c-8ab3-934e833bd688" }, { "id": "42f867e8-a62c-419f-a007-fdf90d3b50ea", "name": "Either segment_id or delete_contacts is not valid", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id?delete_contacts=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "query": [ { "description": "True to delete all contacts matching the segment in addition to deleting the segment", "key": "delete_contacts", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-42f867e8-a62c-419f-a007-fdf90d3b50ea" }, { "id": "c2aecc4d-262e-4b27-a74b-b4dfd1f88966", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id?delete_contacts=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "query": [ { "description": "True to delete all contacts matching the segment in addition to deleting the segment", "key": "delete_contacts", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c2aecc4d-262e-4b27-a74b-b4dfd1f88966" }, { "id": "bc837164-c0f9-4d68-a3b2-337039ef3dab", "name": "Returned if `segment_id` does not exist", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments/:segment_id?delete_contacts=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments", ":segment_id" ], "query": [ { "description": "True to delete all contacts matching the segment in addition to deleting the segment", "key": "delete_contacts", "value": "" } ], "variable": [ { "key": "segment_id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-bc837164-c0f9-4d68-a3b2-337039ef3dab" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-45696564-adc4-424a-a252-6b1624f47899" } ], "id": "bf366952-0a08-4acd-9e16-e4ff29bc1552", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-bf366952-0a08-4acd-9e16-e4ff29bc1552" }, { "name": "Create a Segment", "id": "42c76bfb-6c88-41c5-a081-396f5fc1611f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] }, "description": "**This endpoint allows you to create a new segment.**\n\n\n Valid operators for create and update depend on the type of the field for which you are searching.\n\n**Dates**\n- \"eq\", \"ne\", \"lt\" (before), \"gt\" (after)\n - You may use MM/DD/YYYY for day granularity or an epoch for second granularity.\n- \"empty\", \"not_empty\"\n- \"is within\"\n - You may use an [ISO 8601 date format](https://en.wikipedia.org/wiki/ISO_8601) or the # of days.\n\n**Text**\n- \"contains\"\n- \"eq\" (is/equals - matches the full field)\n- \"ne\" (is not/not equals - matches any field where the entire field is not the condition value)\n- \"empty\"\n- \"not_empty\"\n\n**Numbers**\n- \"eq\" (is/equals)\n- \"lt\" (is less than)\n- \"gt\" (is greater than)\n- \"empty\"\n- \"not_empty\"\n\n**Email Clicks and Opens**\n- \"eq\" (opened)\n- \"ne\" (not opened)\n\nAll field values must be a string.\n\n\nConditions using \"eq\" or \"ne\" for email clicks and opens should provide a \"field\" of either `clicks.campaign_identifier` or `opens.campaign_identifier`.\nThe condition value should be a string containing the id of a completed campaign.\n\n\nThe conditions list may contain multiple conditions, joined by an \"and\" or \"or\" in the \"and_or\" field.\n\nThe first condition in the conditions list must have an empty \"and_or\", and subsequent conditions must all specify an \"and_or\"." }, "response": [ { "id": "f447410c-67bf-4d61-bf61-5acaa89913e5", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"eq\",\n \"and_or\": \"or\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-f447410c-67bf-4d61-bf61-5acaa89913e5" }, { "id": "b68ad62d-a882-4de5-9638-cc884273353b", "name": "The request was formatted incorrectly or missing required parameters.", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b68ad62d-a882-4de5-9638-cc884273353b" }, { "id": "ab661ff3-0afa-4614-8873-5f9fe33a00b6", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "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 \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ab661ff3-0afa-4614-8873-5f9fe33a00b6" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-42c76bfb-6c88-41c5-a081-396f5fc1611f" }, { "name": "Retrieve all segments", "id": "10c06f6e-933a-4a78-87d0-c87b617fc6c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] }, "description": "**This endpoint allows you to retrieve all of your segments.**" }, "response": [ { "id": "c7ec1aa5-5e37-4d7a-90c4-0d4145544f9d", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"segments\": [\n {\n \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"ne\",\n \"and_or\": \"\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"contains\",\n \"and_or\": \"\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n },\n {\n \"name\": \"\",\n \"conditions\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"lt\",\n \"and_or\": \"and\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operator\": \"gt\",\n \"and_or\": \"or\"\n }\n ],\n \"list_id\": \"\",\n \"recipient_count\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c7ec1aa5-5e37-4d7a-90c4-0d4145544f9d" }, { "id": "2939a879-6c1a-4773-8e3e-25c1199ef519", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/segments", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "segments" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-2939a879-6c1a-4773-8e3e-25c1199ef519" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-10c06f6e-933a-4a78-87d0-c87b617fc6c9" } ], "id": "a25ab0c4-ea10-44ac-9734-22cfa9ff80ac", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a25ab0c4-ea10-44ac-9734-22cfa9ff80ac" }, { "name": "status", "item": [ { "name": "Get Recipient Upload Status", "id": "a91771af-d7df-4bcd-9b60-8a2a0f7d570e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/status", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "status" ] }, "description": "**This endpoint allows you to check the upload status of a Marketing Campaigns recipient.**" }, "response": [ { "id": "9934295b-eabb-4f95-a172-f6c5a890d2b0", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/status", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9934295b-eabb-4f95-a172-f6c5a890d2b0" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-a91771af-d7df-4bcd-9b60-8a2a0f7d570e" } ], "id": "fb2ebcd4-055e-45de-88c2-5a6848de6f62", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fb2ebcd4-055e-45de-88c2-5a6848de6f62" }, { "name": "exports", "item": [ { "name": "{id}", "item": [ { "name": "Export Recipients Status", "id": "850044ee-ca39-46c9-b5d9-bca619899289", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "id": "2dbaa95d-d297-49cb-8de2-76002ad53529", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint can be used to check the status of a recipient export job**. \n\nTo use this call, you will need the `id` from the \"Export Recipients\" call.\n\nIf you would like to download a list, take the `id` that is returned from the \"Export Recipients\" endpoint and make an API request here to get the `urls`. Once you have the list of URLs, make a `GET` request on each URL to download your CSV file(s).\n\nTwilio SendGrid recommends exporting your recipients regularly as a backup to avoid issues or lost data." }, "response": [ { "id": "536c24a4-b03b-459f-8cb1-e5f3e46159d0", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"failure\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"completed_at\": \"\",\n \"urls\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\",\n \"count\": \"\"\n },\n \"recipient_count\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-536c24a4-b03b-459f-8cb1-e5f3e46159d0" }, { "id": "79dd4942-0b29-4fb2-9811-4d74a5f85b2d", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "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 \"error_id\": \"\",\n \"parameter\": \"\"\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"error_id\": \"\",\n \"parameter\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-79dd4942-0b29-4fb2-9811-4d74a5f85b2d" }, { "id": "fae891ab-67b1-471c-8e14-a2ad1217ba92", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fae891ab-67b1-471c-8e14-a2ad1217ba92" }, { "id": "fad86574-380f-4ce2-895c-c6913eb69e26", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-fad86574-380f-4ce2-895c-c6913eb69e26" }, { "id": "9858fd84-f94a-4d51-9795-6dd1610cd55b", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-9858fd84-f94a-4d51-9795-6dd1610cd55b" }, { "id": "7a000243-2860-434d-bb97-b6fa904099ba", "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/contactdb/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports", ":id" ], "variable": [ { "key": "id" } ] } }, "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 },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7a000243-2860-434d-bb97-b6fa904099ba" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-850044ee-ca39-46c9-b5d9-bca619899289" } ], "id": "40cb3ebf-38d8-4fa1-ac7a-3283ee99ebf4", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-40cb3ebf-38d8-4fa1-ac7a-3283ee99ebf4" }, { "name": "Export Recipients", "id": "5af9e582-9f0d-4600-8566-93cdf78b65db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] }, "description": "**Use this endpoint to export lists or segments of recipients**.\n\nIf you would just like to have a link to the exported list sent to your email set the `notifications.email` option to `true` in the `POST` payload.\n\nIf you would like to download the list, take the `id` that is returned and use the \"Export Recipients Status\" endpoint to get the `urls`. Once you have the list of URLs, make a `GET` request to each URL provided to download your CSV file(s).\n\nYou specify the segments and or/recipient lists you wish to export by providing the relevant IDs in, respectively, the `segment_ids` and `list_ids` fields in the request body.\n\nThe lists will be provided in either JSON or CSV files. To specify which of these you would required, set the request body `file_type` field to `json` or `csv`.\n\nYou can also specify a maximum file size (in MB). If the export file is larger than this, it will be split into multiple files." }, "response": [ { "id": "d8ac7ce5-c9c7-45bb-9db1-eab8c300e2e5", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\",\n \"count\": \"\"\n },\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d8ac7ce5-c9c7-45bb-9db1-eab8c300e2e5" }, { "id": "92cea688-1b6e-4ca2-9e5c-cb0cd4112652", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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 \"error_id\": \"\",\n \"parameter\": \"\"\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"error_id\": \"\",\n \"parameter\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-92cea688-1b6e-4ca2-9e5c-cb0cd4112652" }, { "id": "705745f8-86be-4134-9309-650f44f786f3", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-705745f8-86be-4134-9309-650f44f786f3" }, { "id": "b4faf761-4ca8-42e0-afa1-d93205010fd3", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-b4faf761-4ca8-42e0-afa1-d93205010fd3" }, { "id": "ab351bee-0a9b-47ba-b455-9adf0536efbc", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ab351bee-0a9b-47ba-b455-9adf0536efbc" }, { "id": "c7e259c3-6569-46e5-b675-078f9eb256a4", "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 \"list_ids\": [\n \"\",\n \"\"\n ],\n \"segment_ids\": [\n \"\",\n \"\"\n ],\n \"notifications\": {\n \"email\": \"\"\n },\n \"file_type\": \"csv\",\n \"max_file_size\": 5000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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 },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c7e259c3-6569-46e5-b675-078f9eb256a4" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-5af9e582-9f0d-4600-8566-93cdf78b65db" }, { "name": "Get All Existing Exports", "id": "cc29b8df-b87f-47cf-b648-1577f939992a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] }, "description": "**Use this endpoint to retrieve details of all current exported jobs**.\n\nIt will return an array of objects, each of which records an export job in flight or recently completed. \n\nEach object's `export_type` field will tell you which kind of export it is and its `status` field will indicate what stage of processing it has reached. Exports which are `ready` will be accompanied by a `urls` field which lists the URLs of the export's downloadable files \u2014 there will be more than one if you specified a maximum file size in your initial export request.\n\nUse this endpoint if you have exports in flight but do not know their IDs, which are required for the \"Export Recipients Status\" endpoint." }, "response": [ { "id": "dc94d063-d508-49e7-b52f-66b8dfae42c7", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"expires_at\": \"\",\n \"urls\": [\n \"\",\n \"\"\n ],\n \"user_id\": \"\",\n \"export_type\": \"\",\n \"segments\": [\n {\n \"ID\": \"\",\n \"Name\": \"\"\n },\n {\n \"ID\": \"\",\n \"Name\": \"\"\n }\n ],\n \"lists\": [\n {\n \"ID\": \"\",\n \"Name\": \"\"\n },\n {\n \"ID\": \"\",\n \"Name\": \"\"\n }\n ],\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"expires_at\": \"\",\n \"urls\": [\n \"\",\n \"\"\n ],\n \"user_id\": \"\",\n \"export_type\": \"\",\n \"segments\": [\n {\n \"ID\": \"\",\n \"Name\": \"\"\n },\n {\n \"ID\": \"\",\n \"Name\": \"\"\n }\n ],\n \"lists\": [\n {\n \"ID\": \"\",\n \"Name\": \"\"\n },\n {\n \"ID\": \"\",\n \"Name\": \"\"\n }\n ],\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n }\n ],\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-dc94d063-d508-49e7-b52f-66b8dfae42c7" }, { "id": "50895189-6de7-406a-a966-e34dac997f64", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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 \"error_id\": \"\"\n },\n {\n \"message\": \"\",\n \"error_id\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-50895189-6de7-406a-a966-e34dac997f64" }, { "id": "7a649674-2f7a-4037-9e28-b920f2bcad01", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-7a649674-2f7a-4037-9e28-b920f2bcad01" }, { "id": "4d08360d-01f0-4ce6-8004-b78a083dff9c", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-4d08360d-01f0-4ce6-8004-b78a083dff9c" }, { "id": "62fdc789-8b3e-41fb-9ee5-fb46aa4e9c38", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "status": "Not Found", "code": 404, "_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:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-62fdc789-8b3e-41fb-9ee5-fb46aa4e9c38" }, { "id": "31aa0206-240a-43ed-846a-51a5907d6911", "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/contactdb/exports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "contactdb", "exports" ] } }, "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 },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-31aa0206-240a-43ed-846a-51a5907d6911" } ], "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-cc29b8df-b87f-47cf-b648-1577f939992a" } ], "id": "d8bdc807-a5af-4a89-8e02-44a1a3a6b155", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-d8bdc807-a5af-4a89-8e02-44a1a3a6b155" } ], "id": "c5ab3f27-45cf-4b8f-811e-03ed4a04f54f", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-c5ab3f27-45cf-4b8f-811e-03ed4a04f54f" } ], "id": "ba332ba1-160a-48b5-a540-4bb3e8f65f79", "createdAt": "2026-06-05T15:17:21.000Z", "updatedAt": "2026-06-05T15:17:21.000Z", "uid": "35240-ba332ba1-160a-48b5-a540-4bb3e8f65f79" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sendgrid.com" } ] }