--- openapi: 3.0.3 info: title: Braze REST API – Cancel exports by segment description: 'Use this endpoint to cancel all ongoing exports with a specified segment ID. ' version: 1.0.0 contact: name: Braze Support url: https://www.braze.com/docs/braze_support/ license: name: Braze Documentation url: https://www.braze.com/docs/api/home/ servers: - url: https://rest.iad-01.braze.com description: US-01 - url: https://rest.iad-02.braze.com description: US-02 - url: https://rest.iad-03.braze.com description: US-03 - url: https://rest.iad-04.braze.com description: US-04 - url: https://rest.iad-05.braze.com description: US-05 - url: https://rest.iad-06.braze.com description: US-06 - url: https://rest.iad-07.braze.com description: US-07 - url: https://rest.iad-08.braze.com description: US-08 - url: https://rest.us-10.braze.com description: US-10 - url: https://rest.fra-01.braze.eu description: EU-01 - url: https://rest.fra-02.braze.eu description: EU-02 - url: https://rest.au-01.braze.com description: AU-01 - url: https://rest.id-01.braze.com description: ID-01 - url: https://rest.jp-01.braze.com description: JP-01 - url: https://rest.kr-01.braze.com description: KR-01 security: - BearerAuth: [] paths: "/users/export/segment/cancel": post: summary: Cancel exports by segment description: | > Use this endpoint to cancel all ongoing exports with a specified segment ID. ## Prerequisites To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with the `users.export.segment` permission. ## Rate limit We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). ## Request body ``` Content-Type: application/json Authorization: Bearer YOUR-REST-API-KEY ``` ```json { "segment_id": (required, string) the `segment_id` to locate and cancel its ongoing exports } ``` ## Request parameters The following table lists the request parameters for this endpoint. | Parameter | Required | Data Type | Description | | --------- | ---------| --------- | ----------- | | `segment_id` | Required | String | The `segment_id` to cancel its ongoing exports. | ## Example request ``` curl --location --request POST 'https://rest.iad-01.braze.com/export/segment/cancel' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR-REST-API-KEY' \ --data-raw '{ "segment_id": "segment_identifier" }' ``` ## Response status codes The following table lists the responses for this endpoint, the error message you may receive, and how to resolve it. | Status code | Meaning | Error message | How to resolve | | --- | --- | --- | --- | | `200 OK` | The cancellation request was accepted. | `success` | No action needed. | | `400 Bad Request` | There are no in-progress exports to cancel for the given `segment_id`. | `nothing-to-cancel` | Verify the `segment_id` has an export in progress before canceling. | | `401 Unauthorized` | The REST API key is missing, malformed, or sent to the wrong REST endpoint. | `Invalid API key` | Send the key as `Authorization: Bearer YOUR_REST_API_KEY` to the correct [REST endpoint]({{site.baseurl}}/api/basics/#endpoints). For more causes, see [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors). | | `403 Access Denied` | The REST API key doesn't have the required permission. | `Access Denied` | Use a REST API key that has the `users.export.segment` permission. | | `429 Rate Limited` | You exceeded the rate limit for this endpoint. | `Over rate limit` | Slow your request rate and retry with exponential backoff. See [API rate limits]({{site.baseurl}}/api/api_limits/). | | `5XX Internal Server Error` | An unexpected error occurred on the Braze server. | `Internal Server Error` | Retry with exponential backoff. If the error persists, contact [Support]({{site.baseurl}}/braze_support/). | operationId: post_export_segment_cancel_post_cancel_export tags: - Export responses: '200': description: The cancellation request was accepted. content: application/json: schema: $ref: '#/components/schemas/CancelExportResponse' '400': description: There are no in-progress exports to cancel for the given `segment_id`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: The REST API key is missing, malformed, or sent to the wrong REST endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The REST API key doesn't have the required permission. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: You exceeded the rate limit for this endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '5XX': description: An unexpected error occurred on the Braze server. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' requestBody: required: true content: application/json: schema: type: object properties: segment_id: type: string description: The `segment_id` to cancel its ongoing exports. required: - segment_id examples: example_request: summary: Example request value: segment_id: segment_identifier components: schemas: CancelExportResponse: type: object properties: message: type: string description: Returns `success` when the request completes without errors. ErrorResponse: type: object properties: message: type: string description: The error message describing why the request failed. errors: type: array description: Non-fatal errors encountered while processing the request. Data unaffected by these errors is still processed. items: type: object properties: type: type: string description: The error type. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: REST API key