Skip to content
Navigation

Detaches a file from a resource, keeping the file.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/attachments/{attachment}/detach

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • attachment
    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
    optional
    object

    The asset the caller saw bound; any other refuses.

    • id
      string
      required
      maxLength: 512 · minLength: 1
  • from_role
    optional
    body
    or
    staged
    or
    staged_file
    or
    prose
    or
    teaser
    or
    embed
    +5 more

    The role the caller saw it hold; another refuses.

  • body
    optional

    The body the caller saw on the target, null for none; another refuses.

    One of the following:

    • object
    • null

Returns

200

Detaches a file from a resource, keeping the file.

JSON
  • id
    string
    required
  • deleted
    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