Create a collection. | Scout API & SDK Reference

curl -X POST https://api.scoutos.com/v2/collections \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "collection_config": {
      "collection_display_name": "Spring Art Collection",
      "collection_img_url": "https://example.com/images/spring-art-collection.jpg",
      "collection_description": "A curated collection of vibrant spring-themed artworks from emerging artists.",
      "tags": [
        "art",
        "spring",
        "painting",
        "emerging artists"
      ]
    },
    "last_updated_at": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "last_updated_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "collection_id": "c1234567-89ab-4def-0123-456789abcdef",
    "revision_id": "r9876543-21ba-fedc-0987-654321fedcba"
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

collection_display_namestringOptionalDefaults to Untitled

collection_img_urlstring or nullOptional

collection_descriptionstring or nullOptional

tagslist of stringsOptional

table_orderlist of stringsOptional

collection_idstring or nullOptional

Optional user-provided collection ID. Must be a lowercase slug (a-z, 0-9, hyphens, underscores) between 3 and 63 characters. If omitted, an ID is auto-generated.

Response

Successful Response

dataobject or null

Errors

422

Unprocessable Entity Error