Flambe docs
API referenceCreators

Rename a creator

PATCH
/api/v2/creators/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

A Clerk session JWT. Obtain one with a Clerk frontend SDK (session.getToken()) or, for server-to-server use, with a Clerk machine token. The token's sub claim is the Flambe user id that scopes every request.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/creators/string" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string"  }'
{  "id": "string",  "display_name": "Samin Nosrat",  "profiles": [    {      "profile_key": "string",      "platform": "instagram",      "handle": "string",      "url": "http://example.com",      "avatar_url": "http://example.com",      "creator_id": "string"    }  ]}

List creators GET

Previous Page

Subscribe to live events GET

A [Server-Sent Events](https://developer.mozilla.org/docs/Web/API/Server-sent_events) stream of changes to the caller's data — most usefully, import progress and completion, which removes the need to poll `GET /api/imports/{id}`. The connection is authenticated with the usual `Authorization: Bearer` header. Note that the browser's built-in `EventSource` cannot set headers, so on the web you need a fetch-based SSE client. The server sends a comment line every few seconds as a keep-alive; ignore lines beginning with `:`.