SendGrid

Twilio SendGrid Marketing Campaigns Segments API

This API was deprecated on December 31, 2022. Following deprecation, all segments created in the Marketing Campaigns user interface began using the…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This API was deprecated on December 31, 2022. Following deprecation, all segments created in the Marketing Campaigns user interface began using the Segmentation v2 API.

To enable manual migration and data retrieval, this API's GET and DELETE operations will remain available. The POST (create) and PATCH (update) endpoints were removed on January 31, 2023 because it is no longer possible to create new v1 segments or modify existing ones. See our Segmentation v1 to v2 upgrade instructions to manually migrate your segments to the v2 API.

Endpoints 3

Segmenting Contacts

  • GETGet List of Segments/v3/marketing/segments?ids=string&parent_list_ids=string&no_parent_list_id=falseThis endpoint allows you to retrieve a list of segments. The query param parent_list_ids is treated as a filter. Any match will be returned. Zero matches will…
  • GETGet Segment by ID/v3/marketing/segments/:segment_id?query_json=trueThis endpoint allows you to retrieve a single segment by ID.
  • DELETEDelete Segment/v3/marketing/segments/:segment_idThis endpoint allows you to delete a segment by segment_id. Note that deleting a segment does not delete the contacts associated with the segment by default.…

API details

Base URL
https://api.sendgrid.com
Authentication
A bearer token in the Authorization header
Operations
3 operations on 2 pathsGET 2DELETE 1
Main resources
Segmenting Contacts 3
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Twilio SendGrid Marketing Campaigns Segments API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Marketing Campaigns Segments API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get List of Segments” (GET /v3/marketing/segments?ids=string&parent_list_ids=string&no_parent_list_id=false), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio SendGrid Marketing Campaigns Segments API?

This API was deprecated on December 31, 2022. Following deprecation, all segments created in the Marketing Campaigns user interface began using the… It is listed under Communication and has 3 endpoints.

Who publishes the Twilio SendGrid Marketing Campaigns Segments API?

It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio SendGrid Marketing Campaigns Segments API?

Requests go to https://api.sendgrid.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio SendGrid Marketing Campaigns Segments API?

With A bearer token in the Authorization header.

How many endpoints does the Twilio SendGrid Marketing Campaigns Segments API have?

3 operations on 2 paths (2 GET, 1 DELETE). The largest groups are Segmenting Contacts.

Is forking the Twilio SendGrid Marketing Campaigns Segments API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.