On this page

Create a Custom Field

API Overview

(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on the Custom Fields API, please visit the new Marketing Campaigns Custom Fields API.

The Custom Fields API lets you create and manage custom fields for your contacts. Custom fields are used to store additional information about your contacts. For example, you might use custom fields to store a contact's birthday, their favorite color, or any other information that is relevant to your business.

Operation overview

POST/v3/contactdb/custom_fields

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to create a custom field.

You can create up to 120 custom fields.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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 <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: <subuser-username>). See On Behalf Of for more information.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringOptional

typestringOptional

Responses

201400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestring

The name of the field

typeenum<string>

The type of the field.

Possible values:

datetextnumber

idnumber

The ID of the custom field.

Create a Custom Field

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  name: "pet",
6  type: "text",
7};
8
9const request = {
10  url: `/v3/contactdb/custom_fields`,
11  method: "POST",
12  body: data,
13};
14
15client
16  .request(request)
17  .then(([response, body]) => {
18    console.log(response.statusCode);
19    console.log(response.body);
20  })
21  .catch((error) => {
22    console.error(error);
23  });