endstate.collections.update

update(collectionId: string, body: UpdateCollectionRequest, options?: RequestOptions): Promise<Collection>


Endpoint	`PATCH /v1/collections/{collection_id}`
Credential	Secret key (`end_sk_...`)
Retry class	`write`

Never repeated. The API accepts no idempotency key here, so a second send is a second write. Only 429 rate_limit.exceeded is retried.

Example

const result = await endstate.collections.update(collection.id, {
  redirect_url: "https://brand.example/p",
});

string

required

Collection id.

string | null

required

Tap redirect URL for this collection’s units. Send null to clear.

200 - Collection.

string

required

object

required

string | null

required

string | null

required

string | null

required

URL a tap on this collection’s units redirects to. Unit- and product-level redirects take precedence over this value.

Branch on error.code, never on the HTTP status - several codes share one.

See Errors and retries for the error types and how to narrow them.