Skip to main content
PATCH
Update collection

Authorizations

Authorization
string
header
required

API key: Authorization: Bearer ck_live_…

Path Parameters

collection_id
string
required

Body

application/json
name
string
description
string | null
visibility
enum<string>
Available options:
private,
public
language
enum<string>
Available options:
pt,
en
price_coins
number

0 = free; >0 makes the collection paid.

Required range: x >= 0
billing_period
enum<string> | null

Required when price_coins > 0.

Available options:
once,
monthly,
null
expose_reporters
boolean
expose_channels
boolean
expose_contents
boolean
expose_documents
boolean

Response

Updated.

collection
object