{ "info": { "_postman_id": "fdd909b8-9a50-404e-9b87-fe9ff5f2566e", "name": "Twilio SendGrid Marketing Campaigns Custom Fields API", "description": "The Twilio SendGrid Marketing Campaigns Custom Fields API allows you to add extra information about your marketing contacts that is relevant to your needs. For example, a fashion retailer might create a custom field for customers' shoe sizes, an ice cream shop might store customers' favorite flavors in a custom field, and you can create custom fields that make sense for your business.\n\nWith custom fields, you can also create [segments](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/) based on custom fields values. Your custom fields are completely customizable to the use-cases and user information that you need.\n\nYou can also manage your Custom Fields using the SendGrid application user interface. See [**Using Custom Fields**](https://docs.sendgrid.com/ui/managing-contacts/custom-fields) for more information, including a list of Reserved Fields. You can also manage your custom fields in the [Marketing Campaigns application user interface](https://mc.sendgrid.com/custom-fields).\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:28.000Z", "updatedAt": "2026-06-05T15:17:28.000Z", "lastUpdatedBy": "35240", "uid": "35240-fdd909b8-9a50-404e-9b87-fe9ff5f2566e" }, "item": [ { "name": "v3", "item": [ { "name": "marketing", "item": [ { "name": "field_definitions", "item": [ { "name": "{custom_field_id}", "item": [ { "name": "Update Custom Field Definition", "id": "c4c8717f-e99e-4791-98a4-9c54b6b40042", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "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/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":custom_field_id" ], "variable": [ { "id": "aedc59f5-53dc-483e-848c-2fea9fbd57c0", "key": "custom_field_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint allows you to update a defined Custom Field.**\n\nOnly your Custom fields can be modified; Reserved Fields cannot be updated." }, "response": [ { "id": "044d89df-fe31-4fa7-90f5-ff98eba49cc3", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":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 \"field_type\": \"Number\",\n \"id\": \"\",\n \"name\": \"\",\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\",\n \"count\": \"\"\n }\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-044d89df-fe31-4fa7-90f5-ff98eba49cc3" }, { "id": "59fbad8b-9dfb-4372-9efb-046bfa07084b", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":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 \"error_id\": \"\",\n \"parameter\": \"\"\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"error_id\": \"\",\n \"parameter\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-59fbad8b-9dfb-4372-9efb-046bfa07084b" }, { "id": "5123bca6-76d6-4c7e-acc1-c1dad360bc97", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":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 \"error_id\": \"\",\n \"parameter\": \"\"\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"error_id\": \"\",\n \"parameter\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-5123bca6-76d6-4c7e-acc1-c1dad360bc97" } ], "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-c4c8717f-e99e-4791-98a4-9c54b6b40042" }, { "name": "Delete Custom Field Definition", "id": "92735415-f098-4957-9648-cca9adce2bf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":custom_field_id" ], "variable": [ { "id": "3fbb1b44-d829-46de-b8f1-d267a919bb8e", "key": "custom_field_id", "value": "", "description": "(Required) " } ] }, "description": "**This endpoint deletes a defined Custom Field.**\n\nYou can delete only Custom Fields; Reserved Fields cannot be deleted." }, "response": [ { "id": "c5a8dbb3-22b1-4c9e-a388-a489c2dcec45", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":custom_field_id" ], "variable": [ { "key": "custom_field_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-c5a8dbb3-22b1-4c9e-a388-a489c2dcec45" }, { "id": "a57e674a-4bce-4996-bdea-a76c6e34903b", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions/:custom_field_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions", ":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 \"error_id\": \"\",\n \"parameter\": \"\"\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"error_id\": \"\",\n \"parameter\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-a57e674a-4bce-4996-bdea-a76c6e34903b" } ], "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-92735415-f098-4957-9648-cca9adce2bf7" } ], "id": "769641e3-2157-45f6-afa9-f1aac7eb7c4e", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-769641e3-2157-45f6-afa9-f1aac7eb7c4e" }, { "name": "Create Custom Field Definition", "id": "d423b56c-7b57-4bba-9a1b-c29bf472ca98", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"field_type\": \"Number\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions" ] }, "description": "**This endpoint creates a new custom field definition.**\n\nCustom field definitions are created with the given `name` and `field_type`. Although field names are stored in a case-sensitive manner, all field names must be case-insensitively unique. This means you may create a field named `CamelCase` or `camelcase`, but not both. Additionally, a Custom Field name cannot collide with any Reserved Field names. You should save the returned `id` value in order to update or delete the field at a later date. You can have up to 500 custom fields.\n\nThe custom field name should be created using only alphanumeric characters (A-Z and 0-9) and underscores (\\_). Custom fields can only begin with letters A-Z or underscores (_). The field type can be date, text, or number fields. The field type is important for creating segments from your contact database.\n\n**Note: Creating a custom field that begins with a number will cause issues with sending in Marketing Campaigns.**" }, "response": [ { "id": "e0411950-250c-4c22-837f-8103ae5236f3", "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 \"name\": \"\",\n \"field_type\": \"Number\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"field_type\": \"Number\",\n \"id\": \"\",\n \"name\": \"\",\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\",\n \"count\": \"\"\n }\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-e0411950-250c-4c22-837f-8103ae5236f3" }, { "id": "e110cfaf-15d0-4482-ace8-5a60c12f876b", "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 \"name\": \"\",\n \"field_type\": \"Number\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions" ] } }, "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:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-e110cfaf-15d0-4482-ace8-5a60c12f876b" } ], "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-d423b56c-7b57-4bba-9a1b-c29bf472ca98" }, { "name": "Get All Field Definitions", "id": "b3c90f0e-1447-4919-9eae-e04a93ee2ae7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/marketing/field_definitions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions" ] }, "description": "**This endpoint retrieves all defined Custom Fields and Reserved Fields.**" }, "response": [ { "id": "c5be0d82-7f0f-4bed-89c5-4df28230360e", "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/marketing/field_definitions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketing", "field_definitions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"field_type\": \"Date\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"field_type\": \"Text\"\n }\n ],\n \"reserved_fields\": [\n {\n \"name\": \"\",\n \"field_type\": \"Date\",\n \"read_only\": false\n },\n {\n \"name\": \"\",\n \"field_type\": \"Date\",\n \"read_only\": false\n }\n ],\n \"_metadata\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\",\n \"count\": \"\"\n }\n}", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-c5be0d82-7f0f-4bed-89c5-4df28230360e" } ], "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-b3c90f0e-1447-4919-9eae-e04a93ee2ae7" } ], "id": "cbd891a1-b7f1-4e0e-ae8a-8594720fef08", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-cbd891a1-b7f1-4e0e-ae8a-8594720fef08" } ], "id": "aaa7ddbc-1a99-4d60-8adf-c65ce681ec96", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-aaa7ddbc-1a99-4d60-8adf-c65ce681ec96" } ], "id": "a9fa2bb2-bcb8-4266-9ef6-4643e8f6f1b8", "createdAt": "2026-06-05T15:17:29.000Z", "updatedAt": "2026-06-05T15:17:29.000Z", "uid": "35240-a9fa2bb2-bcb8-4266-9ef6-4643e8f6f1b8" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sendgrid.com" } ] }