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 Segments API

Twilio SendGrid Legacy Marketing Campaigns Contacts: Segments API

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

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

This API exposes 6 operations across 3 paths, and defines 9 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.

6 operations 3 paths 9 schemas 1 DELETE3 GET1 PATCH1 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 Segments 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 6

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

Segments 6

Twilio SendGrid Legacy Marketing Campaigns Contacts: Segments API

POST
/v3/contactdb/segments
Create a Segment
CreateSegment 1 param body → 200400401
GET
/v3/contactdb/segments
Retrieve all segments
ListSegment 1 param → 200401
GET
/v3/contactdb/segments/{segment_id}
Retrieve a segment
GetSegment 2 params → 200400401404
PATCH
/v3/contactdb/segments/{segment_id}
Update a segment
UpdateSegment 2 params body → 200400401
DELETE
/v3/contactdb/segments/{segment_id}
Delete a segment
DeleteSegment 3 params → 204400401404
GET
/v3/contactdb/segments/{segment_id}/recipients
Retrieve recipients on a segment
ListRecipientForSegment 4 params → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ContactdbSegmentsId200 (5 properties), ContactdbCustomFieldIdValue (4 properties), ContactdbSegments (4 properties), ContactdbSegmentsConditions (4 properties). Each schema is shown below with its type and property counts.

ContactdbCustomFieldIdValue
object
4 properties
Type
string
Operator
string
ContactdbSegmentsId200
object
5 properties 3 required
ErrorResponse
object
2 properties
ContactdbSegments
object
4 properties 2 required
ContactdbRecipient200
object
1 property
AndOr
string
ContactdbSegmentsConditions
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendgrid-segments-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 Custom Fields API
SendGrid Designs API
Where this information came from

This is an independent, third-party profile of SendGrid Segments 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.