API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

urlRedirectCreate mutation

Version unstable

Creates a redirect.

Required access

write_online_store_navigation access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Argument Description
urlRedirect ( UrlRedirectInput! ) required

The fields to use when creating the redirect.

UrlRedirectInput fields

  • path (String)

    The old path to be redirected. When the user visits this path, they will be redirected to the target.

  • target (String)

    The target location where the user will be redirected.

Return fields