> For the complete documentation index, see [llms.txt](https://doc.batch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.batch.com/developer/api.md).

# API

- [API - Customer Engagement Platform](https://doc.batch.com/developer/api/cep.md)
- [Profiles](https://doc.batch.com/developer/api/cep/profiles.md)
- [Update profile](https://doc.batch.com/developer/api/cep/profiles/update.md)
- [Mass update profile](https://doc.batch.com/developer/api/cep/profiles/mass-update-profile.md)
- [Export profile data](https://doc.batch.com/developer/api/cep/profiles/export.md)
- [Audiences](https://doc.batch.com/developer/api/cep/audiences.md)
- [Create](https://doc.batch.com/developer/api/cep/audiences/create.md)
- [Update](https://doc.batch.com/developer/api/cep/audiences/update.md)
- [Replace](https://doc.batch.com/developer/api/cep/audiences/replace.md)
- [Remove](https://doc.batch.com/developer/api/cep/audiences/remove.md)
- [List](https://doc.batch.com/developer/api/cep/audiences/list.md)
- [View](https://doc.batch.com/developer/api/cep/audiences/view.md)
- [Campaigns](https://doc.batch.com/developer/api/cep/campaigns.md)
- [Create campaign](https://doc.batch.com/developer/api/cep/campaigns/create.md)
- [Update campaign](https://doc.batch.com/developer/api/cep/campaigns/update.md)
- [Delete campaign](https://doc.batch.com/developer/api/cep/campaigns/delete.md)
- [Catalogs](https://doc.batch.com/developer/api/cep/catalogs.md)
- [Create catalog](https://doc.batch.com/developer/api/cep/catalogs/create.md)
- [Update catalog](https://doc.batch.com/developer/api/cep/catalogs/update.md)
- [Remove catalog](https://doc.batch.com/developer/api/cep/catalogs/remove.md)
- [View catalog](https://doc.batch.com/developer/api/cep/catalogs/view.md)
- [List catalogs](https://doc.batch.com/developer/api/cep/catalogs/list.md)
- [Edit catalog items](https://doc.batch.com/developer/api/cep/catalogs/edit-items.md)
- [Replace start](https://doc.batch.com/developer/api/cep/catalogs/replace-start.md)
- [Replace items](https://doc.batch.com/developer/api/cep/catalogs/replace-items.md)
- [Replace complete](https://doc.batch.com/developer/api/cep/catalogs/replace-complete.md)
- [Replace cancel](https://doc.batch.com/developer/api/cep/catalogs/replace-cancel.md)
- [Exports](https://doc.batch.com/developer/api/cep/exports.md)
- [List export requests](https://doc.batch.com/developer/api/cep/exports/list.md)
- [View export request](https://doc.batch.com/developer/api/cep/exports/view.md)
- [Download export file](https://doc.batch.com/developer/api/cep/exports/download.md)
- [Orchestrations](https://doc.batch.com/developer/api/cep/orchestrations.md)
- [List orchestrations](https://doc.batch.com/developer/api/cep/orchestrations/list.md)
- [Get orchestrations stats](https://doc.batch.com/developer/api/cep/orchestrations/stats.md)
- [View Push Campaign](https://doc.batch.com/developer/api/cep/orchestrations/view.md)
- [Segments](https://doc.batch.com/developer/api/cep/segments.md)
- [List segments](https://doc.batch.com/developer/api/cep/segments/list.md)
- [API Changelog](https://doc.batch.com/developer/api/cep/api-changelog.md)
- [API - Mobile Engagement Platform](https://doc.batch.com/developer/api/mep.md)
- [Status](https://doc.batch.com/developer/api/mep/status.md): This page is the single source of truth for the status of every MEP API.
- [Transactional](https://doc.batch.com/developer/api/mep/transactional.md)
- [POST - Send](https://doc.batch.com/developer/api/mep/transactional/send.md)
- [GET - Get stats](https://doc.batch.com/developer/api/mep/transactional/stats.md)
- [Campaigns](https://doc.batch.com/developer/api/mep/campaigns.md)
- [POST - Create campaign](https://doc.batch.com/developer/api/mep/campaigns/create.md)
- [POST - Update campaign](https://doc.batch.com/developer/api/mep/campaigns/update.md)
- [POST - Delete campaign](https://doc.batch.com/developer/api/mep/campaigns/delete.md)
- [GET - Get campaign stats](https://doc.batch.com/developer/api/mep/campaigns/get.md)
- [GET - View campaign](https://doc.batch.com/developer/api/mep/campaigns/get-campaign.md)
- [GET - List campaigns](https://doc.batch.com/developer/api/mep/campaigns/list.md)
- [Parameters](https://doc.batch.com/developer/api/mep/campaigns/parameters.md)
- [Advanced](https://doc.batch.com/developer/api/mep/campaigns/advanced.md)
- [In-app Campaigns](https://doc.batch.com/developer/api/mep/in-app-campaigns-api.md)
- [POST - Create In-App campaign](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/create.md)
- [POST - Update In-App campaign](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/update.md)
- [POST - Delete In-App campaign](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/delete.md)
- [GET - List In-App campaigns](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/list.md)
- [GET - View In-App campaign](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/get-campaign.md)
- [Parameters](https://doc.batch.com/developer/api/mep/in-app-campaigns-api/parameters.md)
- [Custom Audience](https://doc.batch.com/developer/api/mep/custom-audience.md)
- [v1.0](https://doc.batch.com/developer/api/mep/custom-audience/1.0.md)
- [POST - Create](https://doc.batch.com/developer/api/mep/custom-audience/1.0/create.md)
- [PATCH - Update](https://doc.batch.com/developer/api/mep/custom-audience/1.0/update.md)
- [DELETE - Remove](https://doc.batch.com/developer/api/mep/custom-audience/1.0/delete.md)
- [GET - List](https://doc.batch.com/developer/api/mep/custom-audience/1.0/list.md)
- [GET - View](https://doc.batch.com/developer/api/mep/custom-audience/1.0/get.md)
- [v1.1 (install ids only)](https://doc.batch.com/developer/api/mep/custom-audience/1.1.md)
- [POST - Create](https://doc.batch.com/developer/api/mep/custom-audience/1.1/create.md)
- [PATCH - Update](https://doc.batch.com/developer/api/mep/custom-audience/1.1/update.md)
- [PUT - Replace](https://doc.batch.com/developer/api/mep/custom-audience/1.1/replace.md)
- [DELETE - Remove](https://doc.batch.com/developer/api/mep/custom-audience/1.1/delete.md)
- [GET - List](https://doc.batch.com/developer/api/mep/custom-audience/1.1/list.md)
- [GET - View](https://doc.batch.com/developer/api/mep/custom-audience/1.1/get.md)
- [Custom Data](https://doc.batch.com/developer/api/mep/custom-data-api.md)
- [POST - Set or update](https://doc.batch.com/developer/api/mep/custom-data-api/set-update.md)
- [DELETE - Remove](https://doc.batch.com/developer/api/mep/custom-data-api/delete.md)
- [App Data](https://doc.batch.com/developer/api/mep/app-data.md)
- [POST - Create](https://doc.batch.com/developer/api/mep/app-data/create.md)
- [GET - List](https://doc.batch.com/developer/api/mep/app-data/list.md)
- [DELETE - Remove](https://doc.batch.com/developer/api/mep/app-data/remove.md)
- [PATCH - Update](https://doc.batch.com/developer/api/mep/app-data/update.md)
- [GDPR](https://doc.batch.com/developer/api/mep/gdpr.md)
- [POST - Create request](https://doc.batch.com/developer/api/mep/gdpr/create.md)
- [GET - Get all requests](https://doc.batch.com/developer/api/mep/gdpr/get-all-requests.md)
- [GET - Get request](https://doc.batch.com/developer/api/mep/gdpr/get-status.md)
- [Export](https://doc.batch.com/developer/api/mep/export.md)
- [POST - Create request](https://doc.batch.com/developer/api/mep/export/create.md)
- [GET - Get request info](https://doc.batch.com/developer/api/mep/export/get-status.md)
- [GET - Get all requests](https://doc.batch.com/developer/api/mep/export/get-all-requests.md)
- [Webhooks](https://doc.batch.com/developer/api/mep/webhooks.md)
- [Trigger Events](https://doc.batch.com/developer/api/mep/trigger-events-api.md)
- [POST - Track events](https://doc.batch.com/developer/api/mep/trigger-events-api/track-events.md)
- [Parameters](https://doc.batch.com/developer/api/mep/trigger-events-api/parameters.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.batch.com/developer/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.