v1

latestOpenAPI 3.1.02026-07-247620.1 KB

Edit Collection

This API route allows a developer application to edit one of the authenticated user's ShopMy collections. This route requires the user to permission your app for the write_collections scope. Collection privacy cannot be updated through this endpoint.

put/Collections/{id}

Path parameters

idinteger required

Collection ID to edit.

Request body

namestring

Collection name (optional)

descriptionstring

Collection description (optional)

Section_idinteger

Section to move the collection into. The section must belong to the authenticated user (optional).

Response

200

successboolean required

Example response

{
  "success": true,
  "collection": {
    "id": 12345,
    "name": "Summer Favorites",
    "description": "My favorite pieces for summer.",
    "image": "https://example.com/collection.jpg",
    "social_links": [
      "https://www.instagram.com/example"
    ],
    "Section_id": 123,
    "url": "https://shopmy.us/collections/12345"
  }
}