API v1 resource list

Generated from the routes themselves, so it lists exactly what is served. The base URL is https://api.dropfans.io. Each operation keeps the name, path and parameters of the public API contract that API v1 follows, so an app written against that contract finds the same operation under the same name here, and the link to it ends in the same slug (for example #list-media-links-cursor-paginated). Operations that are not listed answer 404 {"message": "Resource not found"}.

122 operations.

Account and audience#

Get account view for a managed creator#

GET /v1/creators/{creatorUserUuid}/account

• Scopes: read:creator
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)

List users blocked by a creator (cursor-paginated)#

GET /v1/creators/{creatorUserUuid}/blocks

• Scopes: read:creator read:chat read:fan
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)

Block a user on behalf of a creator#

POST /v1/creators/{creatorUserUuid}/blocks/{userUuid}

• Scopes: write:chat read:creator
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)

Unblock a user on behalf of a creator#

DELETE /v1/creators/{creatorUserUuid}/blocks/{userUuid}

• Scopes: write:chat read:creator
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)

Update creator's subscription price#

PATCH /v1/creators/{creatorUserUuid}/subscription-price

• Scopes: write:creator
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)

Get followers (cursor-paginated)#

GET /v1/followers

• Scopes: read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/followers (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get subscribers (cursor-paginated)#

GET /v1/subscribers

• Scopes: read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/subscribers (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get subscriber by user UUID#

GET /v1/subscribers/{userUuid}

• Scopes: read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/subscribers/{userUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get subscriber history#

GET /v1/subscribers/{userUuid}/history

• Scopes: read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/subscribers/{userUuid}/history (+ read:creator)
• v1 only

Get current user's account#

GET /v1/users/account

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Get current user#

GET /v1/users/me

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Update subscription price#

PATCH /v1/users/me/subscription-price

• Scopes: write:creator
• Also under /v0 and unprefixed (page/size paging)

Agencies and creators#

Invite a creator#

POST /v1/agencies/creator-invites

• Scopes: write:agency
• Also under /v0 and unprefixed (page/size paging)

List per-creator-per-day earnings across all agency creators (cursor-paginated)#

GET /v1/agencies/earnings

• Scopes: read:agency read:creator
• Also under /v0 and unprefixed (page/size paging)

List per-creator-per-day new-follower counts across all agency creators (cursor-paginated)#

GET /v1/agencies/followers-history

• Scopes: read:agency read:creator
• Also under /v0 and unprefixed (page/size paging)

List active subscribers across all agency creators (cursor-paginated)#

GET /v1/agencies/subscribers

• Scopes: read:agency read:creator
• Also under /v0 and unprefixed (page/size paging)

List per-creator-per-day subscriber events across all agency creators (cursor-paginated)#

GET /v1/agencies/subscribers-history

• Scopes: read:agency read:creator
• Also under /v0 and unprefixed (page/size paging)

Get agency creators (cursor-paginated)#

GET /v1/creators

• Scopes: read:creator
• Also under /v0 and unprefixed (page/size paging)

Insights#

Get earnings data#

GET /v1/insights/earnings

• Scopes: read:insights
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/earnings (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get aggregated earnings summary#

GET /v1/insights/earnings/summary

• Scopes: read:insights
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/earnings/summary (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get fan insights in bulk#

GET /v1/insights/fans

• Scopes: read:insights read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/fans (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get fan insights#

GET /v1/insights/fans/{userUuid}

• Scopes: read:insights read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/fans/{userUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get fan insights in bulk (POST batch)#

POST /v1/insights/fans/batch

• Scopes: read:insights read:fan
• Also for an agency: POST /v1/creators/{creatorUserUuid}/insights/fans/batch (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get fan profiles in bulk#

POST /v1/insights/fans/profiles

• Scopes: read:fan
• Also under /v0 and unprefixed (page/size paging)

Get spending reversal data#

GET /v1/insights/spending

• Scopes: read:insights
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/spending (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get subscriber events over time#

GET /v1/insights/subscribers

• Scopes: read:insights
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/subscribers (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get top-spending fans (cursor-paginated)#

GET /v1/insights/top-spenders

• Scopes: read:insights read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/insights/top-spenders (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Media and vault#

Get user's media list (cursor-paginated)#

GET /v1/media

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/media
• Also under /v0 and unprefixed (page/size paging)

Get media by UUID#

GET /v1/media/{uuid}

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/media/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Update media name, caption and recommended price#

PATCH /v1/media/{uuid}

• Scopes: write:media
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/media/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Delete media from vault#

DELETE /v1/media/{uuid}

• Scopes: write:media
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/media/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Get bulk media by UUIDs#

GET /v1/media/bulk

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/media/bulk
• Also under /v0 and unprefixed (page/size paging)

Create multipart upload session#

POST /v1/media/uploads

• Scopes: write:media
• Also for an agency: POST /v1/creators/{creatorUserUuid}/media/uploads
• Also under /v0 and unprefixed (page/size paging)

Complete upload session#

PATCH /v1/media/uploads/{uploadId}

• Scopes: write:media
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/media/uploads/{uploadId}
• Also under /v0 and unprefixed (page/size paging)

Get signed URL for upload part#

GET /v1/media/uploads/{uploadId}/parts/{partNumber}/url

• Scopes: write:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/media/uploads/{uploadId}/parts/{partNumber}/url
• Also under /v0 and unprefixed (page/size paging)

Get signed URLs for a range of upload parts#

GET /v1/media/uploads/{uploadId}/parts/urls

• Scopes: write:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/media/uploads/{uploadId}/parts/urls
• Also under /v0 and unprefixed (page/size paging)

List vault folders (cursor-paginated)#

GET /v1/vault/folders

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/vault/folders
• Also under /v0 and unprefixed (page/size paging)

Create a vault folder#

POST /v1/vault/folders

• Scopes: write:media
• Also for an agency: POST /v1/creators/{creatorUserUuid}/vault/folders
• Also under /v0 and unprefixed (page/size paging)

Get vault folder details#

GET /v1/vault/folders/{folderName}

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/vault/folders/{folderName}
• Also under /v0 and unprefixed (page/size paging)

Rename vault folder#

PATCH /v1/vault/folders/{folderName}

• Scopes: write:media
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/vault/folders/{folderName}
• Also under /v0 and unprefixed (page/size paging)

Delete vault folder#

DELETE /v1/vault/folders/{folderName}

• Scopes: write:media
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/vault/folders/{folderName}
• Also under /v0 and unprefixed (page/size paging)

List media in folder (cursor-paginated)#

GET /v1/vault/folders/{folderName}/media

• Scopes: read:media
• Also for an agency: GET /v1/creators/{creatorUserUuid}/vault/folders/{folderName}/media
• Also under /v0 and unprefixed (page/size paging)

Add media to folder#

POST /v1/vault/folders/{folderName}/media

• Scopes: write:media
• Also for an agency: POST /v1/creators/{creatorUserUuid}/vault/folders/{folderName}/media
• Also under /v0 and unprefixed (page/size paging)

Update media properties#

PATCH /v1/vault/folders/{folderName}/media/{mediaUuid}

• Scopes: write:media
• Also under /v0 and unprefixed (page/size paging)

Remove media from folder#

DELETE /v1/vault/folders/{folderName}/media/{mediaUuid}

• Scopes: write:media
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/vault/folders/{folderName}/media/{mediaUuid}
• Also under /v0 and unprefixed (page/size paging)

Posts#

Bulk-create posts across creators#

POST /v1/agencies/posts

• Scopes: write:post write:creator
• Also under /v0 and unprefixed (page/size paging)

Get list of posts (cursor-paginated)#

GET /v1/posts

• Scopes: read:post
• Also for an agency: GET /v1/creators/{creatorUserUuid}/posts
• Also under /v0 and unprefixed (page/size paging)

Create a new post#

POST /v1/posts

• Scopes: write:post
• Also for an agency: POST /v1/creators/{creatorUserUuid}/posts
• Also under /v0 and unprefixed (page/size paging)

Get post by UUID#

GET /v1/posts/{uuid}

• Scopes: read:post
• Also for an agency: GET /v1/creators/{creatorUserUuid}/posts/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Update a post#

PATCH /v1/posts/{uuid}

• Scopes: write:post
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/posts/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Delete a post#

DELETE /v1/posts/{uuid}

• Scopes: write:post
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/posts/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Get comments for a post (cursor-paginated)#

GET /v1/posts/{uuid}/comments

• Scopes: read:post
• Also for an agency: GET /v1/creators/{creatorUserUuid}/posts/{uuid}/comments
• Also under /v0 and unprefixed (page/size paging)

Create a comment on a post#

POST /v1/posts/{uuid}/comments

• Scopes: write:post
• Also for an agency: POST /v1/creators/{creatorUserUuid}/posts/{uuid}/comments
• Also under /v0 and unprefixed (page/size paging)

Delete a comment from a post#

DELETE /v1/posts/{uuid}/comments/{commentUuid}

• Scopes: write:post
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/posts/{uuid}/comments/{commentUuid}
• Also under /v0 and unprefixed (page/size paging)

Get likes for a post (cursor-paginated)#

GET /v1/posts/{uuid}/likes

• Scopes: read:post
• Also for an agency: GET /v1/creators/{creatorUserUuid}/posts/{uuid}/likes
• Also under /v0 and unprefixed (page/size paging)

Media links#

List media links (cursor-paginated)#

GET /v1/media-links

• Scopes: read:creator
• Also under /v0 and unprefixed (page/size paging)

Create a media link#

POST /v1/media-links

• Scopes: write:creator
• Also under /v0 and unprefixed (page/size paging)

Delete a media link#

DELETE /v1/media-links/{uuid}

• Scopes: write:creator
• Also under /v0 and unprefixed (page/size paging)

Tracking links#

List tracking links#

GET /v1/tracking-links

• Scopes: read:tracking_links
• Also for an agency: GET /v1/creators/{creatorUserUuid}/tracking-links
• Also under /v0 and unprefixed (page/size paging)

Create a tracking link#

POST /v1/tracking-links

• Scopes: write:tracking_links
• Also for an agency: POST /v1/creators/{creatorUserUuid}/tracking-links
• Also under /v0 and unprefixed (page/size paging)

Delete a tracking link#

DELETE /v1/tracking-links/{uuid}

• Scopes: write:tracking_links
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/tracking-links/{uuid}
• Also under /v0 and unprefixed (page/size paging)

List users for a tracking link#

GET /v1/tracking-links/{uuid}/users

• Scopes: read:tracking_links
• Also for an agency: GET /v1/creators/{creatorUserUuid}/tracking-links/{uuid}/users
• Also under /v0 and unprefixed (page/size paging)

Payouts#

List payouts (cursor-paginated)#

GET /v1/payouts

• Scopes: read:payouts
• Also for an agency: GET /v1/creators/{creatorUserUuid}/payouts
• v1 only

Get a payout#

GET /v1/payouts/{uuid}

• Scopes: read:payouts
• Also for an agency: GET /v1/creators/{creatorUserUuid}/payouts/{uuid}
• Also under /v0 and unprefixed (page/size paging)

Get MassPay activation#

GET /v1/payouts/masspay/activation

• Scopes: write:payouts
• Also at GET /v1/creators/{creatorUserUuid}/payouts/masspay/activation for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Get MassPay profile#

GET /v1/payouts/masspay/profile

• Scopes: write:payouts
• Also at GET /v1/creators/{creatorUserUuid}/payouts/masspay/profile for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Set up MassPay profile#

POST /v1/payouts/masspay/profile

• Scopes: write:payouts
• Also at POST /v1/creators/{creatorUserUuid}/payouts/masspay/profile for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

List payout methods#

GET /v1/payouts/methods

• Scopes: read:payouts
• Also for an agency: GET /v1/creators/{creatorUserUuid}/payouts/methods
• Also under /v0 and unprefixed (page/size paging)

Add a payout method#

POST /v1/payouts/methods

• Scopes: write:payouts
• Also at POST /v1/creators/{creatorUserUuid}/payouts/methods for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Update a payout method#

PATCH /v1/payouts/methods/{uuid}

• Scopes: write:payouts
• Also at PATCH /v1/creators/{creatorUserUuid}/payouts/methods/{uuid} for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Delete a payout method#

DELETE /v1/payouts/methods/{uuid}

• Scopes: write:payouts
• Also at DELETE /v1/creators/{creatorUserUuid}/payouts/methods/{uuid} for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Request a payout#

POST /v1/payouts/requests

• Scopes: write:payouts
• Also at POST /v1/creators/{creatorUserUuid}/payouts/requests for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Cancel a payout request#

POST /v1/payouts/requests/{uuid}/cancel

• Scopes: write:payouts
• Also at POST /v1/creators/{creatorUserUuid}/payouts/requests/{uuid}/cancel for a creator your app onboarded. Agencies can read payouts but never change them (403).
• Also under /v0 and unprefixed (page/size paging)

Get payout summary#

GET /v1/payouts/summary

• Scopes: read:payouts
• Also for an agency: GET /v1/creators/{creatorUserUuid}/payouts/summary
• Also under /v0 and unprefixed (page/size paging)

Onboarding#

Onboard a creator#

POST /v1/onboarding/creators

• Scopes: write:creator
• Also under /v0 and unprefixed (page/size paging)

Get a new ID-check link for a creator#

POST /v1/onboarding/creators/{uuid}/kyc-session

• Scopes: write:creator
• Also under /v0 and unprefixed (page/size paging)

Webhooks#

List webhook subscriptions#

GET /v1/webhooks/subscriptions

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Create a webhook subscription#

POST /v1/webhooks/subscriptions

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Delete a webhook subscription#

DELETE /v1/webhooks/subscriptions/{id}

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Send a test webhook event#

POST /v1/webhooks/test

• Scopes: read:self
• Also under /v0 and unprefixed (page/size paging)

Chat (available once chat is enabled)#

List chats across all agency creators (cursor-paginated, filterable)#

GET /v1/agencies/chats

• Scopes: read:agency read:chat
• Also under /v0 and unprefixed (page/size paging)

Get messages from multiple chats in bulk across the agency's creators (POST batch)#

POST /v1/agencies/chats/messages/batch

• Scopes: read:agency read:chat
• Also under /v0 and unprefixed (page/size paging)

Get list of chats (cursor-paginated)#

GET /v1/chats

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Create a new chat#

POST /v1/chats

• Scopes: write:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get a single chat#

GET /v1/chats/{userUuid}

• Scopes: read:chat
• Also under /v0 and unprefixed (page/size paging)

Update chat properties#

PATCH /v1/chats/{userUuid}

• Scopes: write:chat
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/chats/{userUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get media from a chat#

GET /v1/chats/{userUuid}/media

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/{userUuid}/media (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Send a message#

POST /v1/chats/{userUuid}/message

• Scopes: write:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/{userUuid}/message (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get messages from a chat#

GET /v1/chats/{userUuid}/messages

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/{userUuid}/messages (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get a single message#

GET /v1/chats/{userUuid}/messages/{messageUuid}

• Scopes: read:chat
• Also under /v0 and unprefixed (page/size paging)

Delete a message#

DELETE /v1/chats/{userUuid}/messages/{messageUuid}

• Scopes: write:chat
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/chats/{userUuid}/messages/{messageUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Resolve media UUIDs for a chat message#

GET /v1/chats/{userUuid}/messages/{messageUuid}/media

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/{userUuid}/messages/{messageUuid}/media (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get fan notes#

GET /v1/chats/{userUuid}/notes

• Scopes: read:chat read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/{userUuid}/notes (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Update fan notes#

PUT /v1/chats/{userUuid}/notes

• Scopes: write:chat
• Also for an agency: PUT /v1/creators/{creatorUserUuid}/chats/{userUuid}/notes (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Send a typing indicator#

POST /v1/chats/{userUuid}/typing

• Scopes: write:chat
• Also under /v0 and unprefixed (page/size paging)

List automated messages#

GET /v1/chats/automated-messages

• Scopes: read:creator
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/automated-messages
• Also under /v0 and unprefixed (page/size paging)

Enable or update an automated message#

PUT /v1/chats/automated-messages/{trigger}

• Scopes: write:creator
• Also for an agency: PUT /v1/creators/{creatorUserUuid}/chats/automated-messages/{trigger}
• Also under /v0 and unprefixed (page/size paging)

Disable an automated message#

DELETE /v1/chats/automated-messages/{trigger}

• Scopes: write:creator
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/chats/automated-messages/{trigger}
• Also under /v0 and unprefixed (page/size paging)

Get custom lists (cursor-paginated)#

GET /v1/chats/lists/custom

• Scopes: read:chat read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/lists/custom (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Create a custom list#

POST /v1/chats/lists/custom

• Scopes: write:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/lists/custom (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get custom list members (cursor-paginated)#

GET /v1/chats/lists/custom/{uuid}

• Scopes: read:chat read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/lists/custom/{uuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Rename a custom list#

PATCH /v1/chats/lists/custom/{uuid}

• Scopes: write:chat
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/chats/lists/custom/{uuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Delete a custom list#

DELETE /v1/chats/lists/custom/{uuid}

• Scopes: write:chat
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/chats/lists/custom/{uuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Add members to a custom list#

POST /v1/chats/lists/custom/{uuid}/members

• Scopes: write:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/lists/custom/{uuid}/members (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Remove a member from a custom list#

DELETE /v1/chats/lists/custom/{uuid}/members/{userUuid}

• Scopes: write:chat
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/chats/lists/custom/{uuid}/members/{userUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get smart lists#

GET /v1/chats/lists/smart

• Scopes: read:chat read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/lists/smart (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get smart list members (cursor-paginated)#

GET /v1/chats/lists/smart/{uuid}

• Scopes: read:chat read:fan
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/lists/smart/{uuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

List mass messages (cursor-paginated)#

GET /v1/chats/mass-messages

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/mass-messages (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Send a mass message#

POST /v1/chats/mass-messages

• Scopes: write:chat read:fan
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/mass-messages (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Update a scheduled mass message#

PATCH /v1/chats/mass-messages/{messageUuid}

• Scopes: write:chat
• Also for an agency: PATCH /v1/creators/{creatorUserUuid}/chats/mass-messages/{messageUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Delete a mass message#

DELETE /v1/chats/mass-messages/{messageUuid}

• Scopes: write:chat
• Also for an agency: DELETE /v1/creators/{creatorUserUuid}/chats/mass-messages/{messageUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get messages from multiple chats in bulk#

POST /v1/chats/messages/batch

• Scopes: read:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/messages/batch (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get online statuses for multiple users#

POST /v1/chats/statuses

• Scopes: read:chat
• Also for an agency: POST /v1/creators/{creatorUserUuid}/chats/statuses (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get list of template messages (cursor-paginated)#

GET /v1/chats/templates

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/templates (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Create or edit a template message#

POST /v1/chats/templates

• Scopes: write:chat
• Also under /v0 and unprefixed (page/size paging)

Get a single template message#

GET /v1/chats/templates/{templateUuid}

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/templates/{templateUuid} (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Delete a template message#

DELETE /v1/chats/templates/{templateUuid}

• Scopes: write:chat
• Also under /v0 and unprefixed (page/size paging)

Get list of template folders (cursor-paginated)#

GET /v1/chats/templates/folders

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/templates/folders (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Create a template folder#

POST /v1/chats/templates/folders

• Scopes: write:chat
• Also under /v0 and unprefixed (page/size paging)

Rename a template folder#

PATCH /v1/chats/templates/folders/{folderUuid}

• Scopes: write:chat
• Also under /v0 and unprefixed (page/size paging)

Get unread chats, messages, and notifications count#

GET /v1/chats/unread

• Scopes: read:chat
• Also for an agency: GET /v1/creators/{creatorUserUuid}/chats/unread (+ read:creator)
• Also under /v0 and unprefixed (page/size paging)

Get online subscribers#

GET /v1/creators/{creatorUserUuid}/subscribers/online

• Scopes: read:creator read:fan
• Agency creator path only
• Also under /v0 and unprefixed (page/size paging)