Menu

Expand
Rate this page:

Custom Fields

Custom Fields allow you to add extra information about your contacts to your contact database. With custom fields, you can create custom segments from your individual contacts or from your contact database that will dynamically update your content with the values for the individual contact receiving the email. Your custom fields are completely customizable to the use cases and user information that you need.

You can also manage your Custom Fields using the Custom Fields UI in the Marketing Campaigns App. For more about creating Custom Fields, including a list of Reserved Fields, see our Custom Fields documentation.

Delete Custom Field Definition

DELETE /v3/marketing/field_definitions/{custom_field_id}

Base url: https://api.sendgrid.com

This endpoint deletes a defined Custom Field.

You cand delete only Custom Fields; Reserved Fields cannot be deleted.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

custom_field_id
string
default: None
required

Responses

No response body.
object
errors
array[object]
uniqueItems: True
required
message
string
field
string
error_id
string
parameter
string
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more