RESTAdminContentStore ContentImport Export

Create Redirects Export Job

Creates a new 301 Redirects export job.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Content | modify | `store_v2_content` | | Content | read-only | `store_v2_content_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

Data necessary to create a new 301 Redirects export job.
site_idinteger or nullOptional
The site ID for which you wish to export redirects. If no site ID is provided, the request exports all redirects for all sites.
redirect_idslist of integersOptionalDefaults to []
A list of the redirect IDs you wish to export. If no redirect IDs are provided, the request exports all redirects for the given site selection.
include_dynamic_target_urlsbooleanOptionalDefaults to false

If true, the exported CSV will contain an additional read-only column containing the target URL for dynamic redirects.

Response

Created
idstring

Errors

409
Conflict Error
429
Too Many Requests Error