Skip to main content
PATCH
Rename or re-describe

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

id
string
required

Collection id. Never a slug — see the Concepts page.

Body

application/json
title
string
Required string length: 1 - 200
description
string
Maximum string length: 2000

Response

The updated collection.

collection
object
required