Twilio SendGrid Legacy Marketing Campaigns Contacts API
The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we…
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
The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns' Contacts API, Lists API, and Segments API to manage your contacts.
See Migrating from Legacy Marketing Campaigns for more information.
Endpoints 36
Custom Fields
- GETRetrieve all custom fields
/v3/contactdb/custom_fieldsThis endpoint allows you to retrieve all custom fields. - POSTCreate a Custom Field
/v3/contactdb/custom_fieldsThis endpoint allows you to create a custom field. You can create up to 120 custom fields. - GETRetrieve a Custom Field
/v3/contactdb/custom_fields/:custom_field_idThis endpoint allows you to retrieve a custom field by ID. - DELETEDelete a Custom Field
/v3/contactdb/custom_fields/:custom_field_idThis endpoint allows you to delete a custom field by ID. - GETRetrieve reserved fields
/v3/contactdb/reserved_fieldsThis endpoint allows you to list all fields that are reserved and can't be used for custom field names.
Lists
- GETRetrieve all lists
/v3/contactdb/listsThis endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned. - POSTCreate a List
/v3/contactdb/listsThis endpoint allows you to create a list for your recipients. - DELETEDelete Multiple lists
/v3/contactdb/listsThis endpoint allows you to delete multiple recipient lists. - GETRetrieve a single list
/v3/contactdb/lists/:list_idThis endpoint allows you to retrieve a single recipient list. - DELETEDelete a List
/v3/contactdb/lists/:list_id?delete_contacts=trueThis endpoint allows you to delete a specific recipient list with the given ID. - PATCHUpdate a List
/v3/contactdb/lists/:list_idThis endpoint allows you to update the name of one of your recipient lists. - GETRetrieve all recipients on a List
/v3/contactdb/lists/:list_id/recipients?page=0&page_size=0This endpoint allows you to retrieve all recipients on the list with the given ID. - POSTAdd Multiple Recipients to a List
/v3/contactdb/lists/:list_id/recipientsThis endpoint allows you to add multiple recipients to a list. Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs… - POSTAdd a Single Recipient to a List
/v3/contactdb/lists/:list_id/recipients/:recipient_idThis endpoint allows you to add a single recipient to a list. - DELETEDelete a Single Recipient from a Single List
/v3/contactdb/lists/:list_id/recipients/:recipient_idThis endpoint allows you to delete a single recipient from a list.
Recipients
- GETRetrieve recipients
/v3/contactdb/recipients?page=0&page_size=0This endpoint allows you to retrieve all of your Marketing Campaigns recipients. Batch deletion of a page makes it possible to receive an empty page of… - POSTAdd recipients
/v3/contactdb/recipientsThis endpoint allows you to add a Marketing Campaigns recipient. You can add custom field data as a parameter on this endpoint. We have provided an example… - DELETEDelete Recipients
/v3/contactdb/recipientsThis endpoint allows you to deletes one or more recipients. The body of an API call to this endpoint must include an array of recipient IDs of the recipients… - PATCHUpdate Recipient
/v3/contactdb/recipientsThis endpoint allows you to update one or more recipients. The body of an API call to this endpoint must include an array of one or more recipient objects. It… - GETRetrieve a single recipient
/v3/contactdb/recipients/:recipient_idThis endpoint allows you to retrieve a single recipient by ID from your contact database. - DELETEDelete a Recipient
/v3/contactdb/recipients/:recipient_idThis endpoint allows you to delete a single recipient with the given ID from your contact database. > Use this to permanently delete your recipients from all… - GETRetrieve the lists that a recipient is on
/v3/contactdb/recipients/:recipient_id/listsThis endpoint allows you to retrieve the lists that a given recipient belongs to. Each recipient can be on many lists. This endpoint gives you all of the… - GETRetrieve the count of billable recipients
/v3/contactdb/recipients/billable_countThis endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for. You are billed for marketing campaigns based on… - GETRetrieve a Count of Recipients
/v3/contactdb/recipients/countThis endpoint allows you to retrieve the total number of Marketing Campaigns recipients. - GETSearch recipients
/v3/contactdb/recipients/search?{field_name}=stringThis endpoint allows you to perform a search on all of your Marketing Campaigns recipients. field_name: * is a variable that is substituted for your actual… - POSTSearch recipients
/v3/contactdb/recipients/searchSearch using segment conditions without actually creating a segment. Body contains a JSON object with conditions, a list of conditions as described below, and… - GETGet Recipient Upload Status
/v3/contactdb/statusThis endpoint allows you to check the upload status of a Marketing Campaigns recipient. - GETGet All Existing Exports
/v3/contactdb/exportsUse this endpoint to retrieve details of all current exported jobs. It will return an array of objects, each of which records an export job in flight or… - POSTExport Recipients
/v3/contactdb/exportsUse this endpoint to export lists or segments of recipients. If you would just like to have a link to the exported list sent to your email set the… - GETExport Recipients Status
/v3/contactdb/exports/:idThis endpoint can be used to check the status of a recipient export job. To use this call, you will need the id from the "Export Recipients" call. If you…
Segments
- GETRetrieve all segments
/v3/contactdb/segmentsThis endpoint allows you to retrieve all of your segments. - POSTCreate a Segment
/v3/contactdb/segmentsThis endpoint allows you to create a new segment. Valid operators for create and update depend on the type of the field for which you are searching. Dates… - GETRetrieve a segment
/v3/contactdb/segments/:segment_idThis endpoint allows you to retrieve a single segment with the given ID. - DELETEDelete a segment
/v3/contactdb/segments/:segment_id?delete_contacts=trueThis endpoint allows you to delete a segment from your recipients database. You also have the option to delete all the contacts from your Marketing Campaigns… - PATCHUpdate a segment
/v3/contactdb/segments/:segment_idThis endpoint allows you to update a segment. - GETRetrieve recipients on a segment
/v3/contactdb/segments/:segment_id/recipients?page=0&page_size=0This endpoint allows you to retrieve all of the recipients in a segment with the given ID.
API details
- Base URL
https://api.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 36 operations on 19 pathsGET 18POST 8DELETE 7PATCH 3
- Main resources
- Recipients 15Lists 10Segments 6Custom Fields 5
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Legacy Marketing Campaigns Contacts API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Legacy Marketing Campaigns Contacts API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Retrieve all custom fields” (GET /v3/contactdb/custom_fields), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Legacy Marketing Campaigns Contacts API?
The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we… It is listed under Communication and has 36 endpoints.
Who publishes the Twilio SendGrid Legacy Marketing Campaigns Contacts 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 Legacy Marketing Campaigns Contacts API?
Requests go to https://api.sendgrid.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio SendGrid Legacy Marketing Campaigns Contacts API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Legacy Marketing Campaigns Contacts API have?
36 operations on 19 paths (18 GET, 8 POST, 7 DELETE, 3 PATCH). The largest groups are Recipients, Lists, Segments, Custom Fields.
Is forking the Twilio SendGrid Legacy Marketing Campaigns Contacts API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.