Create a collection

POST/v1/collections

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

namestringrequired

descriptionstring

Responses

201

Created collection

idstringrequired

namestringrequired

descriptionstringrequired

ownerstringrequired

created_atstring<date-time>required

updated_atstring<date-time>required

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

namestring*descriptionstring

Request

curl -X POST 'https://api.webfold.ai/v1/collections' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Reading List",
  "description": "Articles to read"
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/collections",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Reading List\",\n  \"description\": \"Articles to read\"\n}",
)

const response = await fetch("https://api.webfold.ai/v1/collections", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Reading List\",\n  \"description\": \"Articles to read\"\n}"
});

Response

{
  "id": "col_1",
  "name": "Reading List",
  "description": "Articles to read",
  "owner": "dev",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

"string"

"string"

"string"