DropfansDropfans
Help CenterFAQDevelopersMini AppSign upLog in
API v1 resource list
Get started
Dropfans APIMake your first callConnect a creator to your appTesting without a sandboxApply for API access
Concepts
Authentication & API keysApps & approvalAPI categoriesRate limitsErrorsPagination & batch limitsModeration & statusesMoney & unitsActing for a creator: agencies and CRMs
Guides
Sell a drop end-to-endUpload images, audio and videoLinks & Telegram deep linksPost to the For You feedEarnings & balanceBroadcast one drop to many fansCreator sign-up from your platformBuild your own CRM dashboard
Webhooks
Webhooks & polling
Build with AI
Build with AIAgent prompt
API v1 (OAuth apps)
OAuth appsAPI v1 overviewAPI v1 resource listAPI v1 webhooks
API reference
API reference overview
▶Account
GETGet the account for this API keyGETGet the profile for a creatorNewPATCHUpdate the profile for a creatorNewGETGet the timezone for a creatorPUTUpdate the timezone for a creatorGETGet the subscription tier for a creatorNewPUTUpdate the subscription tier for a creatorNewGETGet the payout balance for a creator
▶Agencies
GETGet creators and personas for your agencyNewPOSTCreate an AI persona for your agencyNewPATCHUpdate an AI persona for your agencyNewDELDelete an AI persona for your agency (retire)NewPOSTReactivate an AI persona for your agencyNewPOSTCreate a creator invite for your agencyNewGETGet invites for your agency (cursor-paginated)NewDELDelete an invite for your agency (revoke)NewDELRemove a creator from your agencyNewGETGet revenue stats for your agencyNewGETGet daily earnings per creator for your agency (cursor-paginated)New
▶Creators you act for
GETGet creators you can act for (cursor-paginated)NewGETGet a creator you can act forNew
▶Vault
GETGet vault items for a creator (page-paginated)POSTUpload a vault item for a creatorDELDelete a vault item for a creatorPATCHUpdate a vault item’s folder for a creatorPATCHUpdate a vault item’s tags for a creatorGETGet vault folders for a creatorPOSTCreate a vault folder for a creatorDELDelete a vault folder for a creatorPOSTStart a video upload for a creator (step 1 of 3)POSTComplete a video upload for a creator (step 3 of 3)POSTCheck video status for a creator (batch)POSTCreate a media upload for a creatorNewPUTUpload a media upload part for a creatorNewPOSTComplete a media upload for a creatorNewGETGet a media upload for a creatorNew
▶Drops
POSTCreate a drop for a creatorGETGet drops for a creator (cursor-paginated)NewGETGet a drop for a creatorNewPATCHUpdate a drop for a creatorNewDELDelete (archive) a drop for a creatorNewPOSTAttach blur previews to a drop for a creatorPOSTCheck drop sales for a creator (batch)GETGet paid orders for a creator (cursor-paginated)New
▶Posts
POSTCreate a post for a creatorGETGet posts for a creator (page-paginated)GETGet a post for a creatorDELDelete a post for a creator
▶Earnings
GETGet the earnings overview for a creatorGETGet the earnings summary for a creatorNewGETGet transactions for a creator (cursor-paginated)NewGETGet paid tips for a creator (cursor-paginated)New
▶Links
GETGet links for a creatorNewPOSTCreate a link for a creatorNew
▶Telegram (advanced)
GETGet Telegram notification settings for a creatorPUTUpdate Telegram notification settings for a creatorPOSTRegister a Telegram notification chat for a creator
▶CRM integrations
POSTCreate a creator account for your appNewGETGet accounts for your app (cursor-paginated)NewGETGet an account for your appNewPOSTCreate an ID-check link for an accountNewGETGet the webhook endpoint for your appNewPUTUpdate the webhook endpoint for your appNewDELDelete the webhook endpoint for your appNewPOSTRotate the webhook signing secret for your appNewPOSTSend a test webhook event for your appNewGETGet details for your appNewGETGet dashboard stats for your appNewGETGet sales for your app (cursor-paginated)NewGETGet connected accounts for your appNew
▶Payouts
GETGet the payout summary for a creatorNewGETGet payouts for a creator (cursor-paginated)NewGETGet a payout for a creatorNewGETGet payout methods for a creatorNewPOSTCreate a Paxum payout method for a creatorNewPATCHUpdate a payout method for a creatorNewDELDelete a payout method for a creatorNewGETGet the MassPay profile for a creatorNewPOSTCreate the MassPay profile for a creatorNewGETGet MassPay wallet activation for a creatorNewPOSTCreate a payout request for a creatorNewPOSTCancel a payout request for a creatorNew
Resources
ChangelogAPI terms & acceptable use
Developers/API v1 (OAuth apps)/API v1 resource list
API v1 (OAuth apps)

API v1 resource list

Every API v1 operation that is served today, with the scopes it needs and whether it also has the agency creator-path form.

View as MarkdownUpdated Nov 2, 2026
← Previous
API v1 overview
Next →
API v1 webhooks

Questions? support@dropfans.io

On this page
  • Account and audience
  • Get account view for a managed creator
  • List users blocked by a creator (cursor-paginated)
  • Block a user on behalf of a creator
  • Unblock a user on behalf of a creator
  • Update creator's subscription price
  • Get followers (cursor-paginated)
  • Get subscribers (cursor-paginated)
  • Get subscriber by user UUID
  • Get subscriber history
  • Get current user's account
  • Get current user
  • Update subscription price
  • Agencies and creators
  • Invite a creator
  • List per-creator-per-day earnings across all agency creators (cursor-paginated)
  • List per-creator-per-day new-follower counts across all agency creators (cursor-paginated)
  • List active subscribers across all agency creators (cursor-paginated)
  • List per-creator-per-day subscriber events across all agency creators (cursor-paginated)
  • Get agency creators (cursor-paginated)
  • Insights
  • Get earnings data
  • Get aggregated earnings summary
  • Get fan insights in bulk
  • Get fan insights
  • Get fan insights in bulk (POST batch)
  • Get fan profiles in bulk
  • Get spending reversal data
  • Get subscriber events over time
  • Get top-spending fans (cursor-paginated)
  • Media and vault
  • Get user's media list (cursor-paginated)
  • Get media by UUID
  • Update media name, caption and recommended price
  • Delete media from vault
  • Get bulk media by UUIDs
  • Create multipart upload session
  • Complete upload session
  • Get signed URL for upload part
  • Get signed URLs for a range of upload parts
  • List vault folders (cursor-paginated)
  • Create a vault folder
  • Get vault folder details
  • Rename vault folder
  • Delete vault folder
  • List media in folder (cursor-paginated)
  • Add media to folder
  • Update media properties
  • Remove media from folder
  • Posts
  • Bulk-create posts across creators
  • Get list of posts (cursor-paginated)
  • Create a new post
  • Get post by UUID
  • Update a post
  • Delete a post
  • Get comments for a post (cursor-paginated)
  • Create a comment on a post
  • Delete a comment from a post
  • Get likes for a post (cursor-paginated)
  • Media links
  • List media links (cursor-paginated)
  • Create a media link
  • Delete a media link
  • Tracking links
  • List tracking links
  • Create a tracking link
  • Delete a tracking link
  • List users for a tracking link
  • Payouts
  • List payouts (cursor-paginated)
  • Get a payout
  • Get MassPay activation
  • Get MassPay profile
  • Set up MassPay profile
  • List payout methods
  • Add a payout method
  • Update a payout method
  • Delete a payout method
  • Request a payout
  • Cancel a payout request
  • Get payout summary
  • Onboarding
  • Onboard a creator
  • Get a new ID-check link for a creator
  • Webhooks
  • List webhook subscriptions
  • Create a webhook subscription
  • Delete a webhook subscription
  • Send a test webhook event
  • Chat (available once chat is enabled)
  • List chats across all agency creators (cursor-paginated, filterable)
  • Get messages from multiple chats in bulk across the agency's creators (POST batch)
  • Get list of chats (cursor-paginated)
  • Create a new chat
  • Get a single chat
  • Update chat properties
  • Get media from a chat
  • Send a message
  • Get messages from a chat
  • Get a single message
  • Delete a message
  • Resolve media UUIDs for a chat message
  • Get fan notes
  • Update fan notes
  • Send a typing indicator
  • List automated messages
  • Enable or update an automated message
  • Disable an automated message
  • Get custom lists (cursor-paginated)
  • Create a custom list
  • Get custom list members (cursor-paginated)
  • Rename a custom list
  • Delete a custom list
  • Add members to a custom list
  • Remove a member from a custom list
  • Get smart lists
  • Get smart list members (cursor-paginated)
  • List mass messages (cursor-paginated)
  • Send a mass message
  • Update a scheduled mass message
  • Delete a mass message
  • Get messages from multiple chats in bulk
  • Get online statuses for multiple users
  • Get list of template messages (cursor-paginated)
  • Create or edit a template message
  • Get a single template message
  • Delete a template message
  • Get list of template folders (cursor-paginated)
  • Create a template folder
  • Rename a template folder
  • Get unread chats, messages, and notifications count
  • Get online subscribers

Let your fans show their appreciation.

Become a creatorSign up as a fan

Company

  • Blog
  • About
  • Help & FAQ
  • Availability
  • For Creators
  • Developers

Policy

  • Terms
  • Privacy
  • Refunds
  • DMCA
  • Complaints
  • USC 2257
  • AI Content
  • Cookies

Socials

Dropfans

© 2026 Dropfans. All rights reserved.

Dropfans is operated by KVIQVIEW AB, Reg. No. 559552-3852, Gamla Låssbyvägen 27, Gothenburg, Sweden.

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)