Update a Collection

Update by ID

GET https://api.moltin.com/v2/collections/:id

Path Parameters

Name	Type	Description
id	string	The ID for the collection to update

Headers

Name	Type	Description
Authorization	string	The Bearer token to grant access to the API

Request Body

Name	Type	Description
type	string	Represents the type of object being returned
name	string	The name of the collection
slug	string	A unique slug identifier for the collection
description	string	Any description for this collection
status	string	live or draft depending on the collection status

200

{
    "data": {
        "id": "645f97aa-ae63-4ee9-9259-062e570ba064",
        "type": "collection",
        "status": "draft",
        "name": "Collection #1 Updated",
        "slug": "collection-1-update",
        "description": "First collection updated",
        "meta": {
            "timestamps": {
                "created_at": "2018-05-10T14:23:18+00:00",
                "updated_at": "2018-05-10T14:23:18+00:00"
            }
        },
        "relationships": {}
    }
}

cURL

curl -X PUT https://api.moltin.com/v2/collections/:id \
    -H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{
        "data": {
            "type": "collection",
            "id": "645f97aa-ae63-4ee9-9259-062e570ba064",
            "name": "Collection #1 Updated",
            "slug": "collection-1-update",
            "description": "First collection updated",
            "status": "live"
        }
    }'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway

const Moltin = MoltinGateway({
  client_id: 'X',
  client_secret: 'X'
})

const collectionId = 'xxxx'

const collection = {
    name: "Collection #1 Updated",
    slug: "collection-1-update",
    description: "First collection updated",
    status: "live"
}

Moltin.Collections.Update(collectionId, collection).then(collection => {
  // Do something
})