---
title: "Submit event export request"
method: POST
path: "/peopleevents/1/export"
tags: ["customer-engagement", "people", "events"]
---

# Submit event export request

`POST /peopleevents/1/export`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/peopleevents/1/export`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.

Refer to [product documentation](https://www.infobip.com/docs/people/events#events-in-external-systems) for detailed information on configuring AWS S3 for export, export file format and event data schema. 

**Throttling**

You can have maximum of 72 hours worth of export requests in progress at one time.

## Request body

- A1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94ExportRequestBody
  - `roleArn` string, required: AWS role ARN for accessing S3 bucket. Accepted format: `arn:aws:iam::account:role/role-name-with-path`. Must apply character rules as referenced in [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html).
  - `bucket` string, required: AWS S3 bucket name. Must only contain safe characters, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
  - `region` string, required: AWS S3 client region.
  - `directoryPath` string: AWS S3 directory path. Use `directory/` or a nested directory path `dir1/dir2/directory/`. Must only contain safe characters or an equal sign, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
  - `startTime` string, required: Start time of the export query. Accepted format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time and `endTime`, but no more than 1 year ago. `startTime` and `endTime` must be at most 24 hours apart.
  - `endTime` string, required: End time of the export query. Accepted format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time, and later than `startTime`. `startTime` and `endTime` must be at most 24 hours apart.
  - `definitionIdList` string[]: An optional list of `definitionId`s to use as a whitelist filter for exported events. Accepted format: `["definitionId", "definitionId"]`, e.g. `["formSubmitted", "sms*"]`. A wildcard character '*' may be used to match any number of characters in the `definitionId`. A list of all valid `definitionId`s can be obtained from the [Get list of event definitions](https://www.infobip.com/docs/api#customer-engagement/people/get-events-definitions-for-export) endpoint. The total number of matched `definitionId`s, after wildcard expansion, may not exceed 200. To export all events without filtering, do not specify a `definitionIdList`.
  - `enrichWithMomentsInfo` boolean: If set to `true`, additional information, namely the campaign name, Flow's element name (if applicable), and the campaign start date and time are added to all existing events related to Moments. Defaults to `false`.

## Response `202`

Accepted

- A389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095ExportResponseBody
  - `requestId` string, required: Event export request ID.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)