Skip to content
Navigation

Updates a redirect's source or destination.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/redirects/{redirect}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • redirect
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • from_path
    optional
    string
    maxLength: 2000 · minLength: 1 · pattern: ^/[^\s?#]*$
  • to_path
    optional
    string
    maxLength: 2000 · minLength: 1 · pattern: ^(?:/[^\s\x00-\x1F\x7F-\x9F]*|https?://[^\s\x00-\x1F\x7F-\x9F]+)$
  • status
    optional

    One of the following:

    • number
    • number
    • number
    • number
  • enabled
    optional
    boolean

    Off keeps it but never resolves it.

Returns

200

Updates a redirect's source or destination.

JSON
  • id
    string
    required
  • from_path
    string
    required
  • to_path
    string
    required
  • status
    number
    required
  • enabled
    boolean
    required
  • live
    boolean
    required

    Resolved: enabled and within the redirects of its kind the plan applies.

  • connection_ended_at
    required

    When it was turned off because the connection that set it up ended.

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close