POST /export/realm

Create a public or a standard data export of the organization.

!!! warn ""

**Note**: If you're the administrator of a self-hosted installation,
you may be looking for the documentation on [server data export and
import][data-export] or [server backups][backups].

Changes: Prior to Zulip 10.0 (feature level 304), only public data exports could be created using this endpoint.

New in Zulip 2.1.

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`export_type`	String	No	Whether the data export should be public, full with consent, or full without consent. `public` = Public data only export. `full_with_consent` = Public and private data export (with consent), which includes private data for users who have granted consent. `full_without_consent` = All public and private data export, which includes private data for all users. This option requires the organization to have the `owner_full_content_access` feature enabled. If not specified, defaults to `public`. Changes: Zulip 12.0 (feature level 449) changed the type of this field from int to string with `1` being replaced by `public` and `2` being replaced by `full_with_consent`. The option `full_without_consent` was added for full exports without member consent. Changes: New in Zulip 10.0 (feature level 304). Previously, all export requests were public data exports. Valid values: `"public"` `"full_with_consent"` `"full_without_consent"` Default value: "public"

export_type

String

Whether the data export should be public, full with consent, or full without consent.

public = Public data only export.
full_with_consent = Public and private data export (with consent), which includes private data for users who have granted consent.
full_without_consent = All public and private data export, which includes private data for all users. This option requires the organization to have the owner_full_content_access feature enabled.

If not specified, defaults to public.

Changes: Zulip 12.0 (feature level 449) changed the type of this field from int to string with 1 being replaced by public and 2 being replaced by full_with_consent. The option full_without_consent was added for full exports without member consent.

Changes: New in Zulip 10.0 (feature level 304). Previously, all export requests were public data exports.

Valid values:

"public"
"full_with_consent"
"full_without_consent"

Default value: "public"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.