# Sitecore Send API documentation

> Use the Sitecore Send documentation to programatically manage mailing lists, subscribers, campaigns, and segments.

- Product: Send
- Audience: Developers
- Language: English
- Status: Current
- Canonical URL: https://doc.sitecore.com/send/en/developers/api-documentation

## Overview

- [Introduction to the Sitecore Send API](https://doc.sitecore.com/send/en/developers/api-documentation/introduction-to-the-sitecore-send-api.md): Introduction to the Sitecore Send API and what topics are included in this API documentation.

## Getting started with the Sitecore Send API

- [Getting started with the Sitecore Send API](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api.md): Overview of how to get started with the Sitecore Send API.
- [Base URL](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/base-url.md): Describes the base URL for all Sitecore Send API endpoints.
- [Authenticate a Sitecore Send API request](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/authenticate-a-sitecore-send-api-request.md): Overview of the authentication process and how to get your API key from your Sitecore Send account.
- [HTTP methods](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/http-methods.md): Describes the standard HTTP methods to use when making calls to the Sitecore Send APIs.
- [Request and response parameters](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/request-and-response-parameters.md): Describes the different types of request and response parameters that are used when making calls to the Sitecore Send API.
- [HTTP status codes](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/http-status-codes.md): Describes the possible HTTP status codes returned in the Sitecore Send API response.
- [API rate limiting](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/api-rate-limiting.md): Describes the API rate limiting enforced by Sitecore Send to prevent having too many requests.
- [Create an email list and add subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/walkthrough--create-a-mailing-list-and-add-subscribers.md): Provides a walkthrough in making your first requests to the Sitecore Send API to create a new email list and add multiple subscribers to the list.

### Introduction to segmentation

- [Introduction to segmentation](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/introduction-to-segmentation.md): Provides a basic description of segmentation and the query or expression used in Sitecore Send API calls.
- [List of segmentation fields](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/introduction-to-segmentation/list-of-segmentation-fields.md): Lists the segmentation fields that are used in Sitecore Send API segmentation expressions.
- [List of comparers](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/introduction-to-segmentation/list-of-comparers.md): Lists the comparers or operators that are used in Sitecore Send API segmentation queries.
- [List of date functions](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/introduction-to-segmentation/list-of-date-functions.md): Lists the date functions that are used in Sitecore Send API segmentation fields.
- [List of date constrain parameters](https://doc.sitecore.com/send/en/developers/api-documentation/getting-started-with-the-sitecore-send-api/introduction-to-segmentation/list-of-date-constrain-parameters.md): Lists the date parameters that are used to constrain results of a Sitecore Send API response based on the elapsed time or date span.

## API reference

- [API reference](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference.md)

### Mailing lists

- [Mailing lists](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists.md): Describes how to use the Sitecore Send API to create, edit, and manage email lists in your account.
- [Get all active mailing lists](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/get-all-active-mailing-lists.md): Describes the request and response details of this Sitecore Send API endpoint to get your active email lists.
- [Get mailing list details](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/get-mailing-list-details.md): Describes the request and response details of this Sitecore Send API endpoint to get your email list details.
- [Get all active mailing lists with paging](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/get-all-active-mailing-lists-with-paging.md): Describes the request and response details of this Sitecore Send API endpoint to get your active email lists with paging information included.
- [Create a mailing list](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/create-a-mailing-list.md): Describes the request and response details of this Sitecore Send API endpoint to create an email list.
- [Update a mailing list](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/update-a-mailing-list.md): Describes the request and response details of this Sitecore Send API endpoint to update an email list.
- [Delete a mailing list](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/delete-a-mailing-list.md): Describes the request and response details of this Sitecore Send API endpoint to delete an email list.
- [Create a custom field](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/create-a-custom-field.md): Describes the request and response details of this Sitecore Send API endpoint to create a custom field.
- [Update a custom field](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/update-a-custom-field.md): Describes the request and response details of this Sitecore Send API endpoint to update a custom field.
- [Remove a custom field](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/mailing-lists/remove-a-custom-field.md): Describes the request and response details of this Sitecore Send API endpoint to remove a custom field.

### Subscribers

- [Subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers.md): Describes how to use the Sitecore Send API to get, add, update, unsubscribe, and remove subscribers from email lists in your account.
- [Get all subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/get-all-subscribers.md): Describes the request and response details of this Sitecore Send API endpoint to get all your subscribers.
- [Get subscriber by email address](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/get-subscriber-by-email-address.md): Describes the request and response details of this Sitecore Send API endpoint to get a specific subscriber by email address.
- [Get subscriber by ID](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/get-subscriber-by-id.md): Describes the request and response details of this Sitecore Send API endpoint to get a specific subscriber by ID.
- [Get subscriber by ID without mailing list ID](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/get-subscriber-by-id-without-mailing-list-id.md): Describes the request and response details of this Sitecore Send API endpoint to get a specific subscriber by ID.
- [Add a new subscriber](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/add-a-new-subscriber.md): Describes the request and response details of this Sitecore Send API endpoint to add a new subscriber to an email list.
- [Add multiple subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/add-multiple-subscribers.md): Describes the request and response details of this Sitecore Send API endpoint to add multiple subscribers to an email list in a single request.
- [Update a subscriber](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/update-a-subscriber.md): Describes the request and response details of this Sitecore Send API endpoint to update a subscriber in your email list.
- [Unsubscribe a subscriber from an account](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/unsubscribe-a-subscriber-from-an-account.md): Describes the request and response details of this Sitecore Send API endpoint to unsubscribe a subscriber from all email lists in an account.
- [Unsubscribe a subscriber from a mailing list](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/unsubscribe-a-subscriber-from-a-mailing-list.md): Describes the request and response details of this Sitecore Send API endpoint to unsubscribe a subscriber from an email list.
- [Unsubscribe a subscriber from a mailing list and a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/unsubscribe-a-subscriber-from-a-mailing-list-and-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to unsubscribe a subscriber from an email list and a campaign.
- [Remove a subscriber](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/remove-a-subscriber.md): Describes the request and response details of this Sitecore Send API endpoint to remove a subscriber from a specific email list.
- [Remove multiple subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/remove-multiple-subscribers.md): Describes the request and response details of the Sitecore Send API endpoint to remove multiple subscribers from a specific email list.
- [Delete a subscriber](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/delete-a-subscriber.md): Describes the request and response details of this Sitecore Send API endpoint to delete a subscriber from a specific email list permanently.
- [Delete multiple subscribers from a specific mailing list](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/delete-multiple-subscribers-from-a-specific-mailing-list.md): Describes the request and response details of the Sitecore Send API endpoint to delete multiple subscribers from a specific email list permanently.
- [Delete a subscriber from an account](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/subscribers/delete-a-subscriber-from-an-account.md): Describes the request and response details of this Sitecore Send API endpoint to delete a subscriber from the entire account.

### Campaigns

- [Campaigns](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns.md): Describes how to use the Sitecore Send API to get, clone, update, delete, test, and send campaigns, including how to fetch campaign statistics.
- [Get all campaigns by page](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-all-campaigns-by-page.md): Describes the request and response details of this Sitecore Send API endpoint to get all campaigns in your account with paging information.
- [Get all campaigns by page and page size](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-all-campaigns-by-page-and-page-size.md): Describes the request and response details of this Sitecore Send API endpoint to get all campaigns in your account with paging and page size information.
- [Get campaign details](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-details.md): Describes the request and response details of this Sitecore Send API endpoint to get details of a specific campaign.
- [Get all senders](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-all-senders.md): Describes the request and response details of this Sitecore Send API endpoint to get senders of a specific campaign.
- [Get sender details](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-sender-details.md): Describes the request and response details of this Sitecore Send API endpoint to get details of a specific sender.
- [Create a draft campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/create-a-draft-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to create a draft campaign.
- [Manage a transactional campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/manage-a-transactional-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to create a transactional campaign.
- [Dynamic templates for transactional campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/dynamic-templates-for-transactional-campaign.md): Describes the customization generated in Sitecore Send APIs for dynamic templates.
- [Clone an existing campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/clone-an-existing-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to clone a campaign.
- [Delete a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/delete-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to delete a campaign.
- [Update a draft campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/update-a-draft-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to update a draft campaign.
- [Test a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/test-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to test a draft campaign.
- [Send a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/send-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to send a campaign.
- [Schedule a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/schedule-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to schedule a campaign for delivery.
- [Unschedule a campaign](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/unschedule-a-campaign.md): Describes the request and response details of this Sitecore Send API endpoint to unschedule a campaign that is scheduled for delivery.
- [Get campaign statistics](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-statistics.md): Describes the request and response details of this Sitecore Send API endpoint to get campaign statistics.
- [Get campaign statistics with paging and filter](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-statistics-with-paging-and-filter.md): Describes the request and response details of this Sitecore Send API endpoint to get campaign statistics with paging and filter information.
- [Get campaign summary](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-summary.md): Describes the request and response details of this Sitecore Send API endpoint to get a campaign summary.
- [Get campaign activity by location](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-activity-by-location.md): Describes the request and response details of this Sitecore Send API endpoint to get campaign activity by location.
- [Get campaign link activity](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-campaign-link-activity.md): Describes the request and response details of this Sitecore Send API endpoint to get campaign link activity.
- [Get A/B campaign summary](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/campaigns/get-a-b-campaign-summary.md): Describes the request and response details of this Sitecore Send API endpoint to get a summary of an A/B campaign.

### Segments

- [Segments](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments.md): Overview of segmentation and describes how to use the Sitecore Send API to work with segments, subscribers, and criteria.
- [Get all segments](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/get-all-segments.md): Describes the request and response details of this Sitecore Send API endpoint to get all segments created in a mailing list.
- [Get segment details](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/get-segment-details.md): Describes the request and response details of this Sitecore Send API endpoint to get the details of a specific segment.
- [Get segment subscribers](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/get-segment-subscribers.md): Describes the request and response details of this Sitecore Send API endpoint to get the subscribers of a specific segment.
- [Create an empty segment](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/create-an-empty-segment.md): Describes the request and response details of this Sitecore Send API endpoint to create an empty segment in a specific email list.
- [Create a segment with criteria](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/create-a-segment-with-criteria.md): Describes the request and response details of this Sitecore Send API endpoint to create a segment with criteria in a specific email list.
- [Update a segment](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/update-a-segment.md): Describes the request and response details of this Sitecore Send API endpoint to update a segment in a specific email list.
- [Add criteria to a segment](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/add-criteria-to-a-segment.md): Describes the request and response details of this Sitecore Send API endpoint to add criteria or rules to a specific segment.
- [Update segment criteria](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/update-segment-criteria.md): Describes the request and response details of this Sitecore Send API endpoint to update the criteria or rules in a specific segment.
- [Delete a segment](https://doc.sitecore.com/send/en/developers/api-documentation/api-reference/segments/delete-a-segment.md): Describes the request and response details of this Sitecore Send API endpoint to delete a segment in a mailing list.

## Optional

- [Full publication as Markdown](https://doc.sitecore.com/send/en/developers/api-documentation/llms-full.txt): Every article in this publication in a single file.