Creators#
Manage creators (influencers) with social media accounts across six platforms.
List creators#
Retrieve a paginated list of creators for an organization.
const { items, totalCount, facets } = await bw.creators.list({
pageIndex: 0,
pageSize: 25,
organizationId: 'org_123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| pageIndex | integer | Required | Zero-based page index for pagination. |
| pageSize | integer | Required | Number of items per page (1-100). |
| organizationId | string (UUID) | Required | Organization identifier. |
| searchTerm | string | — | Free-text search term to filter results (max 200 characters). |
| sortBy | string | — | Column name to sort by. |
| sortDirection | 'asc' | 'desc' | — | Sort direction: ascending or descending. |
| activityId | string (UUID) | — | Filter by activity identifier. |
| role | 'person' | 'community' | 'brand_partner' | — | Filter by creator role. |
Response#
Returns { items, totalCount, facets } with paginated results.
Get creator stats#
Aggregate statistics for creators matching the given filters.
const { data } = await bw.creators.stats({
organizationId: 'org_123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| activityId | string (UUID) | — | Filter by activity identifier. |
| role | 'person' | 'community' | 'brand_partner' | — | Filter by creator role. |
| searchTerm | string | — | Free-text search term to filter results (max 200 characters). |
Response#
Returns { data } with the result.
Get creator#
Retrieve a single creator by ID with full details and social accounts.
const { data } = await bw.creators({ id: 'abc-123' });Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Creator identifier. |
Response#
Returns { data } with the result.
Create creator#
Create a new creator (influencer) within an organization. Required: organizationId, name. Optional: email, role (person/community/brand_partner), country (2-letter ISO code), notes.
const { data } = await bw.creators.create({
organizationId: 'org_123',
name: 'My Campaign',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| name | string | Required | Creator display name. |
string | null | — | Creator contact email. | |
| role | 'person' | 'community' | 'brand_partner' | null | — | Creator role: "person", "community", or "brand_partner". |
| country | string | null | — | Two-letter ISO 3166-1 country code. |
| notes | string | null | — | Internal notes about this creator (max 2,000 characters). |
Response#
Returns { data } with the result.
Update creator#
Update a creator profile including role, country, and internal notes.
const { data } = await bw.creators.update({
id: 'abc-123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Creator identifier to update. |
| name | string | — | Updated creator name (1-255 characters). |
string | null | — | Updated contact email. | |
| role | 'person' | 'community' | 'brand_partner' | null | — | Updated role: "person", "community", or "brand_partner". |
| country | string | null | — | Updated two-letter ISO 3166-1 country code. |
| notes | string | null | — | Updated internal notes (max 2,000 characters). |
Response#
Returns { data } with the result.
Delete creator#
Permanently delete a creator and all associated data.
const { data } = await bw.creators.delete({
id: 'abc-123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Creator identifier to delete. |
Response#
Returns { data } with the result.
Destructive action
Connect creator social account#
Connect a social media account to a creator via profile URL.
const { data } = await bw.creators.socialAccounts.connect({
creatorId: 'con_abc123',
platform: 'instagram',
profileUrl: '...',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| creatorId | string (UUID) | Required | Creator identifier to connect the account to. |
| platform | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | Required | Social media platform. |
| profileUrl | string | Required | Profile URL or username for the social media account (max 2,048 characters). |
Response#
Returns { data } with the result.
Supported platforms
Disconnect social account#
Disconnect a social media account from a creator.
const { data } = await bw.creators.socialAccounts.disconnect({
creatorId: 'con_abc123',
accountId: '12345678',
platform: 'instagram',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| creatorId | string (UUID) | Required | Creator identifier to disconnect the account from. |
| accountId | string (UUID) | Required | Social media account identifier to disconnect. |
| platform | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | Required | Social media platform. |
Response#
Returns { data } with the result.