How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SendGrid Custom Fields API

Twilio SendGrid Legacy Marketing Campaigns Contacts: Custom Fields API

SendGrid Custom Fields API is one of 63 APIs that SendGrid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com.

9 operations 5 paths 10 schemas 2 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.sendgrid.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

SendGrid Custom Fields API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Twilio SendGrid requires you to authenticate with its APIs using an API key. The API key must be sent as a bearer token in the Authorization header.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 9

Twilio SendGrid Legacy Marketing Campaigns Contacts: Custom Fields API

POST
/v3/contactdb/custom_fields
Create a Custom Field
CreateCustomField 1 param body → 201400
GET
/v3/contactdb/custom_fields
Retrieve all custom fields
ListCustomField 1 param → 200401
GET
/v3/contactdb/custom_fields/{custom_field_id}
Retrieve a Custom Field
GetCustomField 2 params → 200400401404
DELETE
/v3/contactdb/custom_fields/{custom_field_id}
Delete a Custom Field
DeleteCustomField 2 params → 202400401404
GET
/v3/contactdb/reserved_fields
Retrieve reserved fields
ListReservedField 1 param → 200401
POST
/v3/marketing/field_definitions
Create Custom Field Definition
CreateFieldDefinition body → 200400
GET
/v3/marketing/field_definitions
Get All Field Definitions
ListFieldDefinition → 200
PATCH
/v3/marketing/field_definitions/{custom_field_id}
Update Custom Field Definition
UpdateFieldDefinition 1 param body → 200400404
DELETE
/v3/marketing/field_definitions/{custom_field_id}
Delete Custom Field Definition
DeleteFieldDefinition 1 param → 204404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Metadata (4 properties), CustomFieldsError (4 properties), ContactdbCustomFieldId2xx (3 properties), CustomFieldDefinitionsResponse (3 properties). Each schema is shown below with its type and property counts.

Type
string
CustomFieldsError
object
4 properties 1 required
FieldType1
string
Metadata
object
4 properties
ContactdbCustomFieldId2xx
object
3 properties
ReservedFieldDefinitionsResponse
array
2 required
CustomFieldDefinitionsResponse
object
3 properties 3 required
FieldType
string
ErrorResponse
object
2 properties
FieldType2
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendgrid-custom-fields-api-openapi.yml Raw ↑

Other APIs SendGrid publishes across the network.

SendGrid Account API
SendGrid Account State API
SendGrid Alerts API
SendGrid API Keys API
SendGrid Blocks API
SendGrid Bounces API
SendGrid Bulk Email Address Validation API
SendGrid Campaigns API API
SendGrid Categories API
SendGrid Contacts API
SendGrid Designs API
SendGrid Domain Authentication API
Where this information came from

This is an independent, third-party profile of SendGrid Custom Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.