PATCH /v1/bulk-redirects

Edits a single redirect identified by its source path. Stages a new change with the modified redirect and returns the alias for the new version in the response.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
projectId String Yes
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
name String No
restore Boolean No

If true, restores the redirect from the latest production version to staging.

redirect Object Yes

The redirect object to edit. The source field is used to match the redirect to modify.

redirect.source String Yes
redirect.query Boolean No
redirect.statusCode Number No
redirect.destination String No
redirect.preserveQueryParams Boolean No
redirect.permanent Boolean No
redirect.caseSensitive Boolean No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.