Skip to content
Navigation

Sets or clears an integration's settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.

PUT
https://api.sherpo.io/merchant/v1/stores/{store}/integrations/{integration}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • integration
    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

  • config
    optional
    map of
    any of
  • enabled
    optional
    boolean

Returns

200

Sets or clears an integration's settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.

JSON
  • id
    string
    required
  • name
    string
    required
  • description
    required

    One of the following:

    • string
    • null
  • kind
    string
    required
  • sets_cookies
    boolean
    required
  • enabled
    boolean
    required
  • connection_ended_at
    required

    One of the following:

    • string
    • null
  • config_schema
    map of
    any of
    required
  • secret_set
    map of
    boolean
    required
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