SmallForce CLI: Social media commands
Connect social accounts, publish content, manage comments, inbox and reviews, and inspect analytics
This page covers 65 smallforce social commands. It is generated from SmallForce CLI 0.1.17; run smallforce social --help (or any command with --help) to see the same reference for the version you have installed. New to the CLI? Start with installation and authentication and JSON output.
Agent workflow:
1. social platforms list
Read supported platform keys, capabilities, and platformOptions.
2. social profiles list
Reuse a profile id, or create one with social profiles create <name>.
3. social accounts connect <platform> --profile <profileId>
Share the returned authorization URL with the user.
4. social sync accounts --profile <profileId>
Import the provider account after authorization.
5. social accounts list
Use the returned account id inside each post publication object.
6. assets upload <file>
Upload media and use the returned asset id in --asset or --publication.
7. social posts validate ...
8. social posts create ...
Minimal publish example:
$ smallforce social posts create --content "Hello" --publish now \
--publication '{"accountId":"<accountId>"}'
Every leaf command supports --json. Use each leaf's --help for exact input
shapes, enum values, ID sources, and next commands.
Common options
Most commands accept these options as well as their own. Every command also accepts -h, --help.
| Option | Description |
|---|---|
--api-key <key> | SmallForce API key, or set SMALLFORCE_API_KEY |
--backend-url <url> | SmallForce backend URL, or set SMALLFORCE_BACKEND_URL |
--json | Print stable machine-readable JSON |
--text | Print human-readable text |
--format <format> | Output format: text or json |
smallforce social platforms
Inspect supported platforms and platform-specific post options
smallforce social platforms list
List platform keys, capabilities, and publication option schemas
Usage: smallforce social platforms list [options]
Also accepts the common options listed at the top of this page.
Use this before connecting an account or building platformOptions.
Examples:
$ smallforce social platforms list
$ smallforce social platforms list --json
Next:
social profiles list
social accounts connect <platform> --profile <profileId>
smallforce social profiles
Create and list social provider profiles
smallforce social profiles list
List social profiles and the profile IDs used by account connect
Usage: smallforce social profiles list [options]
| Option | Description |
|---|---|
--include-deleted | Include deleted profiles |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social profiles list
$ smallforce social profiles list --json
The returned ID is used by:
social accounts connect <platform> --profile <profileId>
smallforce social profiles create
Create a social profile used to group connected accounts
Usage: smallforce social profiles create [options] <name>
| Argument | Description |
|---|---|
name | Profile name, for example Main brand |
| Option | Description |
|---|---|
--description <text> | Optional profile description |
--color <value> | Optional provider color value |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social profiles create "Main brand"
$ smallforce social profiles create "Main brand" --description "Primary company channels" --json
Next:
social accounts connect <platform> --profile <returnedProfileId>
smallforce social accounts
List, connect, and disconnect social accounts
smallforce social accounts list
List organization-owned social account IDs used by posts, inbox, reviews, and analytics
Usage: smallforce social accounts list [options]
| Option | Description |
|---|---|
--profile <profileId> | Filter by profile id |
--platform <platform> | Filter by platform key |
--kind <kind> | Account kind: posting or ads |
--include-deleted | Include disconnected or deleted accounts |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social accounts list
$ smallforce social accounts list --platform instagram --json
Use the returned account ID in:
--publication '{"accountId":"<accountId>"}'
social inbox conversations list --account <accountId>
social reviews list --account <accountId>
smallforce social accounts connect
Create a provider authorization URL for a social platform
Usage: smallforce social accounts connect [options] <platform>
| Argument | Description |
|---|---|
platform | Platform key from social platforms list |
| Option | Description |
|---|---|
--profile <profileId> | Profile id from social profiles list |
--redirect-url <url> | Browser destination after authorization |
--headless | Request a headless provider authorization flow |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social accounts connect instagram --profile <profileId>
$ smallforce social accounts connect google_business --profile <profileId> --json
Share the returned authUrl with the user. After authorization run:
social sync accounts --profile <profileId>
social accounts list --profile <profileId>
smallforce social accounts disconnect
Disconnect one organization-owned social account
Usage: smallforce social accounts disconnect [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social accounts disconnect <accountId>
This disables the provider account and its local destinations.
smallforce social posts
Validate, publish, inspect, update, cancel, and retry social posts
smallforce social posts list
List social posts and post IDs
Usage: smallforce social posts list [options]
| Option | Description |
|---|---|
--profile <profileId> | Filter by social profile id |
--status <status> | Filter by post status |
--limit <n> | Page size from 1 to 250 |
--cursor <cursor> | Opaque cursor returned by the previous page |
--include-deleted | Include deleted or cancelled posts |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social posts list --status scheduled
$ smallforce social posts list --limit 25 --json
Use nextCursor unchanged with --cursor. Use a returned post ID with posts get,
update, delete, retry, or analytics posts get.
smallforce social posts get
Get one social post, publication statuses, errors, and URLs
Usage: smallforce social posts get [options] <postId>
| Argument | Description |
|---|---|
postId | Post id from social posts list or create |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social posts get <postId>
$ smallforce social posts get <postId> --json
smallforce social posts create
Create a draft, publish now, or schedule a social post
Usage: smallforce social posts create [options]
| Option | Description |
|---|---|
--content <text> | Shared post text |
--title <text> | Internal post title |
--profile <profileId> | Social profile id from social profiles list |
--scheduled-for <iso> | ISO timestamp required for schedule mode |
--timezone <iana> | IANA timezone, for example America/Detroit |
--asset <assetId> | SmallForce asset id; repeat for multiple media (default: []) |
--media-url <url> | Public media URL; repeat for multiple media (default: []) |
--hashtag <tag> | Hashtag without transport-specific formatting; repeatable (default: []) |
--tag <tag> | Internal post tag; repeatable (default: []) |
--publication <json> | Publication object; repeat once per target account (default: []) |
--metadata <json> | Inline JSON object stored with the post |
--publish <mode> | Publish mode: draft, now, or schedule (default: “draft”) |
--idempotency-key <key> | Stable key preventing duplicate creates |
Also accepts the common options listed at the top of this page.
Publication JSON structure:
{
"accountId": "<accountId>", required
"customContent": "Per-account text", optional
"customMediaAssetIds": ["<assetId>"], optional
"customMediaUrls": ["https://..."], optional
"scheduledFor": "2026-07-15T14:00:00Z", optional
"platformOptions": { ... } optional; schema comes from platforms list
}
Rules:
- --publish schedule requires --scheduled-for.
- now or schedule requires at least one --publication.
- Repeat --publication for multiple target accounts.
- Use --idempotency-key when an agent may retry the same create.
Examples:
$ smallforce social posts create --profile <profileId> --content "Hello" --publish now \
--publication '{"accountId":"<accountId>"}'
$ smallforce social posts create --profile <profileId> --content "Launch" --publish schedule \
--scheduled-for 2026-07-15T14:00:00Z --timezone America/Detroit \
--asset <assetId> --publication '{"accountId":"<accountId>"}' --json
Google Business platformOptions (inside --publication JSON):
CTA: {"callToAction":{"type":"BOOK","url":"https://example.com/book"}}
Use type, not actionType. Every CTA, including CALL, requires an HTTPS url.
Event: {"topicType":"EVENT","event":{"title":"Open house","schedule":{"startDate":{"year":2027,"month":5,"day":15},"endDate":{"year":2027,"month":5,"day":16}}}}
Event title, startDate and endDate are required. Optional startTime/endTime use
{"hours":9,"minutes":0} at the business location. End cannot precede start.
Offer: {"topicType":"OFFER","offer":{"couponCode":"SAVE20","redeemOnlineUrl":"https://example.com/shop","termsConditions":"Valid this weekend."}}
The offer object is required; its three fields are optional. Add event for
an optional offer heading/validity period. Discover all options with:
smallforce social platforms list --json
Recommended: run the same flags through social posts validate first.
smallforce social posts validate
Validate post content, media, publications, and platformOptions without creating a post
Usage: smallforce social posts validate [options]
| Option | Description |
|---|---|
--content <text> | Shared post text |
--title <text> | Internal post title |
--profile <profileId> | Social profile id from social profiles list |
--scheduled-for <iso> | ISO timestamp required for schedule mode |
--timezone <iana> | IANA timezone, for example America/Detroit |
--asset <assetId> | SmallForce asset id; repeat for multiple media (default: []) |
--media-url <url> | Public media URL; repeat for multiple media (default: []) |
--hashtag <tag> | Hashtag without transport-specific formatting; repeatable (default: []) |
--tag <tag> | Internal post tag; repeatable (default: []) |
--publication <json> | Publication object; repeat once per target account (default: []) |
--metadata <json> | Inline JSON object stored with the post |
--publish <mode> | Publish mode: draft, now, or schedule (default: “draft”) |
--idempotency-key <key> | Stable key preventing duplicate creates |
Also accepts the common options listed at the top of this page.
Uses the same flags and publication structure as social posts create.
Minimal example:
$ smallforce social posts validate --profile <profileId> --content "Hello" --publish now \
--publication '{"accountId":"<accountId>"}'
For platformOptions, first run:
social platforms list --json
smallforce social posts update
Update an editable draft, scheduled, failed, partial, or cancelled post
Usage: smallforce social posts update [options] <postId>
| Argument | Description |
|---|---|
postId | Post id from social posts list |
| Option | Description |
|---|---|
--content <text> | Shared post text |
--title <text> | Internal post title |
--profile <profileId> | Social profile id from social profiles list |
--scheduled-for <iso> | ISO timestamp required for schedule mode |
--timezone <iana> | IANA timezone, for example America/Detroit |
--asset <assetId> | SmallForce asset id; repeat for multiple media (default: []) |
--media-url <url> | Public media URL; repeat for multiple media (default: []) |
--hashtag <tag> | Hashtag without transport-specific formatting; repeatable (default: []) |
--tag <tag> | Internal post tag; repeatable (default: []) |
--publication <json> | Publication object; repeat once per target account (default: []) |
--metadata <json> | Inline JSON object stored with the post |
--publish <mode> | Publish mode: draft, now, or schedule |
--mention <value> | Mention value; repeatable (default: []) |
--visibility <value> | private, public, or unlisted |
--crossposting <true|false> | Enable or disable crossposting |
--recycling <json> | Inline JSON recycling configuration |
Also accepts the common options listed at the top of this page.
Only pass fields that should change. --publication replaces the publication
targets when supplied and uses the same JSON structure as posts create.
Examples:
$ smallforce social posts update <postId> --profile <profileId> --content "Revised caption"
$ smallforce social posts update <postId> --profile <profileId> --publish schedule \
--scheduled-for 2026-07-15T14:00:00Z --json
Published posts may only accept recycling changes; create a new post for
published content, media, target, or schedule changes.
smallforce social posts delete
Delete a draft or cancel a scheduled post
Usage: smallforce social posts delete [options] <postId>
| Argument | Description |
|---|---|
postId | Post id from social posts list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social posts delete <postId>
Failed or partial posts use social posts retry instead. Published provider
posts cannot be deleted through this command.
smallforce social posts retry
Retry a failed or partially published social post
Usage: smallforce social posts retry [options] <postId>
| Argument | Description |
|---|---|
postId | Failed or partial post id from social posts list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social posts retry <postId>
Inspect the post first with social posts get <postId> to see publication errors.
smallforce social comments
List organic comment threads and manage public or private replies
Paid ad comments are intentionally separate under the advertisements surface.
Workflow:
1. social comments threads list
2. social comments list <threadId>
3. social comments reply <threadId> --parent <commentId> --message "<reply>"
smallforce social comments threads
List posts with organic comments
smallforce social comments threads list
Refresh and list organization-owned organic comment threads
Usage: smallforce social comments threads list [options]
| Option | Description |
|---|---|
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Organic social platform key |
--sort <field> | date or comments |
--order <order> | asc or desc |
--limit <n> | Page size from 1 to 100 |
--cursor <cursor> | Opaque cursor from the previous page |
--include-deleted | Include locally deleted threads |
Also accepts the common options listed at the top of this page.
smallforce social comments list
Refresh and list comments in one local thread
Usage: smallforce social comments list [options] <threadId>
| Argument | Description |
|---|---|
threadId | Thread id from social comments threads list |
| Option | Description |
|---|---|
--parent <commentId> | Page replies to a local Facebook, Instagram, or Reddit comment |
--limit <n> | Page size from 1 to 100 |
--cursor <cursor> | Opaque provider cursor from the previous page |
Also accepts the common options listed at the top of this page.
smallforce social comments reply
Publish a top-level comment or reply to a specific comment
Usage: smallforce social comments reply [options] <threadId>
| Argument | Description |
|---|---|
threadId | Thread id from social comments threads list |
| Option | Description |
|---|---|
--message <text> | Public reply text |
--parent <commentId> | Comment id from social comments list |
--attachment-url <url> | Public Facebook image URL |
Also accepts the common options listed at the top of this page.
smallforce social comments edit
Edit a Reddit comment
Usage: smallforce social comments edit [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
| Option | Description |
|---|---|
--message <text> | Replacement comment text |
Also accepts the common options listed at the top of this page.
smallforce social comments delete
Delete a provider comment
Usage: smallforce social comments delete [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
Also accepts the common options listed at the top of this page.
smallforce social comments hide
Hide a supported provider comment
Usage: smallforce social comments hide [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
Also accepts the common options listed at the top of this page.
smallforce social comments unhide
Unhide a supported provider comment
Usage: smallforce social comments unhide [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
Also accepts the common options listed at the top of this page.
smallforce social comments unlike
Remove the connected account’s like
Usage: smallforce social comments unlike [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
Also accepts the common options listed at the top of this page.
smallforce social comments like
Like or react to a supported provider comment
Usage: smallforce social comments like [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
| Option | Description |
|---|---|
--reaction <type> | LinkedIn reaction: LIKE, PRAISE, EMPATHY, INTEREST, APPRECIATION, or ENTERTAINMENT |
Also accepts the common options listed at the top of this page.
smallforce social comments moderate
Set YouTube comment moderation status
Usage: smallforce social comments moderate [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
| Option | Description |
|---|---|
--status <status> | published, rejected, or heldForReview |
--ban-author | Ban the author; valid only with rejected |
Also accepts the common options listed at the top of this page.
smallforce social comments private-reply
Send a Facebook or Instagram private reply to a comment
Usage: smallforce social comments private-reply [options] <commentId>
| Argument | Description |
|---|---|
commentId | Comment id from social comments list |
| Option | Description |
|---|---|
--message <text> | Private message text |
--quick-reply <json> | Quick-reply object; repeatable and mutually exclusive with —button (default: []) |
--button <json> | URL, postback, or phone button object; repeatable (default: []) |
Also accepts the common options listed at the top of this page.
smallforce social inbox
List conversations, inspect messages, mark conversations read, and send replies
Workflow:
1. inbox conversations list
2. inbox messages list <conversationId>
3. inbox messages send <conversationId> --message "<reply>"
First-time messages to a Facebook Page wait in Meta's requests folder until
the Page replies: see inbox requests --help.
Conversation IDs come from conversations list. Account IDs come from
social accounts list.
smallforce social inbox analytics
Inspect inbox volume, activity timing, sources, response time, accounts, and conversations
smallforce social inbox analytics volume
Show sent and received volume
Usage: smallforce social inbox analytics volume [options]
| Option | Description |
|---|---|
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
--source <source> | api, broadcast, comment_automation, contact, human, platform, sequence, or workflow |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics heatmap
Show inbox activity by weekday and hour
Usage: smallforce social inbox analytics heatmap [options]
| Option | Description |
|---|---|
--action <action> | all, message.received, message.sent, or message.read |
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
--source <source> | api, broadcast, comment_automation, contact, human, platform, sequence, or workflow |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics sources
Break inbox activity down by message source
Usage: smallforce social inbox analytics sources [options]
| Option | Description |
|---|---|
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics response-time
Show inbox response-time percentiles and histogram
Usage: smallforce social inbox analytics response-time [options]
| Option | Description |
|---|---|
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics top-accounts
Rank inbox accounts by message activity
Usage: smallforce social inbox analytics top-accounts [options]
| Option | Description |
|---|---|
--limit <n> | Maximum accounts from 1 to 100 |
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
--source <source> | api, broadcast, comment_automation, contact, human, platform, sequence, or workflow |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics conversations
List or inspect per-conversation inbox analytics
smallforce social inbox analytics conversations list
List conversation-level inbox metrics
Usage: smallforce social inbox analytics conversations list [options]
| Option | Description |
|---|---|
--limit <n> | Page size from 1 to 100 |
--page <n> | Page number |
--order <order> | asc or desc |
--sort-by <metric> | lastMessageAt, firstMessageAt, totalMessages, received, sent, read, or failed |
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key |
--source <source> | api, broadcast, comment_automation, contact, human, platform, sequence, or workflow |
Also accepts the common options listed at the top of this page.
smallforce social inbox analytics conversations get
Show analytics for one SmallForce conversation id
Usage: smallforce social inbox analytics conversations get [options] <conversationId>
| Argument | Description |
|---|---|
conversationId | Conversation id from social inbox conversations list |
| Option | Description |
|---|---|
--from <date> | Inclusive start date in YYYY-MM-DD |
--to <date> | Inclusive end date in YYYY-MM-DD |
Also accepts the common options listed at the top of this page.
smallforce social inbox requests
Facebook message requests: first-time messages Meta keeps out of the inbox until the Page replies
Requests are read live from Meta, for Facebook Pages only (Instagram has no
separate requests folder apps can read). Replying accepts a request and moves
it into the inbox as an ordinary conversation. Meta allows that reply only
within 24 hours of the person's last message.
Workflow:
1. inbox requests list
2. inbox requests messages <requestId> --account <accountId>
3. inbox requests accept <requestId> --account <accountId> --message "<reply>"
smallforce social inbox requests list
List message requests across Facebook Pages, newest first
Usage: smallforce social inbox requests list [options]
| Option | Description |
|---|---|
--account <accountId> | Only this Facebook Page (account id from social accounts list) |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social inbox requests list --json
smallforce social inbox requests messages
Read a request’s messages, when Meta shows them before it is accepted
Usage: smallforce social inbox requests messages [options] <requestId>
| Argument | Description |
|---|---|
requestId | Request id from inbox requests list |
| Option | Description |
|---|---|
--account <accountId> | The Page account id the request was sent to |
Also accepts the common options listed at the top of this page.
When Meta does not show a request's messages before it is accepted, the
result says so and the request's last message (from requests list) is all
there is to read.
Example:
$ smallforce social inbox requests messages <requestId> --account <accountId>
smallforce social inbox requests accept
Accept a request by replying to it; it then moves into the inbox
Usage: smallforce social inbox requests accept [options] <requestId>
| Argument | Description |
|---|---|
requestId | Request id from inbox requests list |
| Option | Description |
|---|---|
--account <accountId> | The Page account id the request was sent to |
--message <text> | The reply that accepts the request |
Also accepts the common options listed at the top of this page.
The reply is sent to the person and accepts the request. Meta refuses it
more than 24 hours after the person's last message; the request then has to
be answered in Facebook.
Example:
$ smallforce social inbox requests accept <requestId> --account <accountId> \
--message "Thanks for reaching out! How can we help?"
smallforce social inbox conversations
List and manage inbox conversations
smallforce social inbox conversations list
List organization-owned inbox conversations and conversation IDs
Usage: smallforce social inbox conversations list [options]
| Option | Description |
|---|---|
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | Platform key from social platforms list |
--status <status> | active or archived |
--limit <n> | Page size from 1 to 250 |
--cursor <cursor> | Opaque cursor returned by the previous page |
--include-deleted | Include deleted conversations |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social inbox conversations list
$ smallforce social inbox conversations list --account <accountId> --json
Use nextCursor unchanged with --cursor. Use a returned conversation ID with
inbox messages list, inbox messages send, or inbox conversations read.
smallforce social inbox conversations get
Refresh and get one organization-owned conversation
Usage: smallforce social inbox conversations get [options] <conversationId>
| Argument | Description |
|---|---|
conversationId | Conversation id from inbox conversations list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social inbox conversations get <conversationId> --json
smallforce social inbox conversations read
Mark one conversation read at the provider and locally
Usage: smallforce social inbox conversations read [options] <conversationId>
| Argument | Description |
|---|---|
conversationId | Conversation id from inbox conversations list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social inbox conversations read <conversationId>
smallforce social inbox messages
List and send messages inside a conversation
smallforce social inbox messages list
List messages for one organization-owned conversation
Usage: smallforce social inbox messages list [options] <conversationId>
| Argument | Description |
|---|---|
conversationId | Conversation id from inbox conversations list |
| Option | Description |
|---|---|
--limit <n> | Page size from 1 to 100 |
--cursor <cursor> | Provider cursor returned by the previous page |
--order <order> | asc or desc |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social inbox messages list <conversationId>
$ smallforce social inbox messages list <conversationId> --order asc --json
Use nextCursor unchanged with --cursor.
smallforce social inbox messages send
Send text, an attachment, quick replies, buttons, a template, or an interactive payload
Usage: smallforce social inbox messages send [options] <conversationId>
| Argument | Description |
|---|---|
conversationId | Conversation id from inbox conversations list |
| Option | Description |
|---|---|
--message <text> | Message text |
--attachment-url <url> | Public attachment URL |
--attachment-name <name> | Attachment filename |
--attachment-type <type> | image, video, audio, or file |
--reply-to <messageId> | Provider message id being replied to |
--voice-note | Send an audio attachment as a voice note |
--quick-reply <json> | Quick-reply object; repeatable (default: []) |
--button <json> | Button object; repeatable (default: []) |
--template <json> | Provider template object |
--interactive <json> | Provider interactive-message object |
Also accepts the common options listed at the top of this page.
At least one of --message, --attachment-url, --template, or --interactive is
required. --quick-reply and --button cannot be used together.
Structured input examples:
--quick-reply '{"title":"Yes","payload":"YES"}'
--button '{"type":"url","title":"Book","url":"https://example.com"}'
--template '{"name":"order_update","language":"en","components":[]}'
--interactive '{"type":"list","body":{"text":"Choose one"}}'
Examples:
$ smallforce social inbox messages send <conversationId> --message "Thanks!"
$ smallforce social inbox messages send <conversationId> \
--attachment-url https://example.com/image.png --attachment-type image --json
smallforce social reviews
List Facebook and Google Business reviews and manage replies
Reviews are cross-platform and remain under social, including Google Business.
Workflow:
1. social reviews list --has-reply false
2. social reviews get <reviewId>
3. social reviews reply <reviewId> --message "<reply>"
smallforce social reviews list
List reviews, ratings, reply state, and review IDs
Usage: smallforce social reviews list [options]
| Option | Description |
|---|---|
--account <accountId> | Account id from social accounts list |
--profile <profileId> | Profile id from social profiles list |
--platform <platform> | facebook or google_business |
--has-reply <true|false> | Filter by reply state |
--min-rating <1-5> | Minimum rating |
--max-rating <1-5> | Maximum rating |
--sort <field> | date or rating |
--order <order> | asc or desc |
--limit <n> | Page size from 1 to 50 |
--cursor <cursor> | Opaque cursor returned by the previous page |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social reviews list --has-reply false
$ smallforce social reviews list --platform google_business --min-rating 1 --max-rating 3 --json
Use a returned review ID with reviews get, reply, or delete-reply.
smallforce social reviews get
Get one organization-owned review
Usage: smallforce social reviews get [options] <reviewId>
| Argument | Description |
|---|---|
reviewId | Review id from social reviews list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social reviews get <reviewId> --json
smallforce social reviews reply
Publish or replace the reply to one review
Usage: smallforce social reviews reply [options] <reviewId>
| Argument | Description |
|---|---|
reviewId | Review id from social reviews list |
| Option | Description |
|---|---|
--message <text> | Reply text |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social reviews reply <reviewId> --message "Thank you for visiting!"
smallforce social reviews delete-reply
Delete the existing provider reply from one review
Usage: smallforce social reviews delete-reply [options] <reviewId>
| Argument | Description |
|---|---|
reviewId | Review id from social reviews list |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social reviews delete-reply <reviewId>
smallforce social sync
Refresh provider profiles, accounts, posts, and external posts into SmallForce
Use sync after account authorization, when importing provider-created posts,
or when local state may be stale. Sync always remains scoped to the API key's
organization.
smallforce social sync accounts
Refresh connected social accounts and destinations
Usage: smallforce social sync accounts [options]
| Option | Description |
|---|---|
--profile <profileId> | Restrict sync to one profile id |
Also accepts the common options listed at the top of this page.
Run this after the user completes a social accounts connect authorization URL.
Examples:
$ smallforce social sync accounts --profile <profileId>
$ smallforce social sync accounts --json
Next:
social accounts list
smallforce social sync profiles
Refresh provider profile metadata
Usage: smallforce social sync profiles [options]
| Option | Description |
|---|---|
--profile <profileId> | Restrict sync to one local profile id |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social sync profiles
$ smallforce social sync profiles --profile <profileId> --json
smallforce social sync posts
Import a page of provider posts for one or all organization profiles
Usage: smallforce social sync posts [options]
| Option | Description |
|---|---|
--profile <profileId> | Restrict sync to one profile |
--status <status> | draft, scheduled, published, or failed |
--limit <n> | Provider page size from 1 to 250 |
--page <n> | Provider page number |
--no-sync-accounts | Do not refresh accounts before post sync |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social sync posts --profile <profileId>
$ smallforce social sync posts --status published --limit 100 --page 1 --json
By default accounts are synced first so provider account mappings are current.
smallforce social sync post
Refresh exactly one organization-owned post
Usage: smallforce social sync post [options]
| Option | Description |
|---|---|
--post <postId> | Local post id from social posts list |
--provider-post <providerPostId> | Provider post id that belongs to an organization account or profile |
Also accepts the common options listed at the top of this page.
Use exactly one identifier:
--post local SmallForce post id; preferred when available
--provider-post raw provider id; ownership is verified before persistence
Examples:
$ smallforce social sync post --post <postId>
$ smallforce social sync post --provider-post <providerPostId> --json
smallforce social sync external-posts
Import provider-created content for one organization-owned account
Usage: smallforce social sync external-posts [options]
| Option | Description |
|---|---|
--account <accountId> | Account id from social accounts list |
--platform-post <providerPostId> | Optional exact provider post id |
--url <postUrl> | Optional public post URL |
Also accepts the common options listed at the top of this page.
The account is always required and organization ownership is checked. Use
--platform-post or --url to target one external post; omit both to let the
provider perform its supported account-level import.
Examples:
$ smallforce social sync external-posts --account <accountId>
$ smallforce social sync external-posts --account <accountId> --url https://instagram.com/p/... --json
smallforce social analytics
Inspect cross-platform, post-level, and provider-specific social analytics
Workflow:
1. social accounts list
2. social analytics daily --account <accountId> --from <date> --to <date>
3. Use provider-specific commands for deeper account insights.
Date ranges use YYYY-MM-DD. General analytics support at most 366 inclusive
days. Provider-specific endpoints may enforce narrower ranges.
smallforce social analytics daily
Get daily cross-platform social metrics
Usage: smallforce social analytics daily [options]
| Option | Description |
|---|---|
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--source <source> | all, smallforce, or external |
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social analytics daily --from 2026-01-01 --to 2026-07-10
$ smallforce social analytics daily --account <accountId> --source all --json
Use account, profile, platform, or no scope. When omitted, analytics cover all
organization profiles available to the provider.
smallforce social analytics best-time
Get provider recommendations for the best time to publish
Usage: smallforce social analytics best-time [options]
| Option | Description |
|---|---|
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--source <source> | all, smallforce, or external |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social analytics best-time --platform instagram
$ smallforce social analytics best-time --account <accountId> --json
This provider endpoint does not accept a date range.
smallforce social analytics content-decay
Measure how quickly published content loses engagement
Usage: smallforce social analytics content-decay [options]
| Option | Description |
|---|---|
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--source <source> | all, smallforce, or external |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics content-decay --account <accountId> --json
This provider endpoint does not accept a date range.
smallforce social analytics posting-frequency
Inspect posting-frequency patterns
Usage: smallforce social analytics posting-frequency [options]
| Option | Description |
|---|---|
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--source <source> | all, smallforce, or external |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics posting-frequency --profile <profileId>
This provider endpoint does not accept a date range.
smallforce social analytics followers
Get follower counts and growth history
Usage: smallforce social analytics followers [options]
| Option | Description |
|---|---|
--granularity <value> | daily, weekly, or monthly |
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social analytics followers --account <accountId> --granularity weekly
$ smallforce social analytics followers --platform instagram --from 2026-01-01 --to 2026-07-10 --json
Source filtering is not supported by this provider endpoint.
smallforce social analytics posts
List analytics across posts or inspect one post timeline
smallforce social analytics posts list
List post analytics with sorting and pagination
Usage: smallforce social analytics posts list [options]
| Option | Description |
|---|---|
--sort <field> | date, engagement, impressions, reach, likes, comments, shares, saves, clicks, or views |
--order <order> | asc or desc |
--limit <n> | Page size from 1 to 250 |
--page <n> | Provider page number |
--account <accountId> | Scope to one account id from social accounts list |
--profile <profileId> | Scope to one profile id from social profiles list |
--platform <platform> | Scope to one platform key |
--source <source> | all, smallforce, or external |
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
Also accepts the common options listed at the top of this page.
Examples:
$ smallforce social analytics posts list --sort engagement --order desc
$ smallforce social analytics posts list --account <accountId> --from 2026-01-01 --to 2026-07-10 --json
smallforce social analytics posts get
Get aggregate analytics for one SmallForce post
Usage: smallforce social analytics posts get [options] <postId>
| Argument | Description |
|---|---|
postId | Post id from social posts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics posts get <postId> --from 2026-01-01 --to 2026-07-10 --json
smallforce social analytics posts timeline
Get time-series analytics for one SmallForce post
Usage: smallforce social analytics posts timeline [options] <postId>
| Argument | Description |
|---|---|
postId | Post id from social posts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics posts timeline <postId> --from 2026-06-01 --to 2026-07-10
smallforce social analytics facebook
Facebook Page analytics
smallforce social analytics facebook page-insights
Get Facebook Page insights
Usage: smallforce social analytics facebook page-insights [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics facebook page-insights <accountId> --metrics page_impressions,page_engaged_users --json
smallforce social analytics instagram
Instagram account, follower, and demographic analytics
smallforce social analytics instagram account-insights
Get Instagram professional-account insights
Usage: smallforce social analytics instagram account-insights [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics instagram account-insights <accountId> --from 2026-06-01 --to 2026-07-10
smallforce social analytics instagram follower-history
Get Instagram follower history
Usage: smallforce social analytics instagram follower-history [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics instagram follower-history <accountId> --json
smallforce social analytics instagram demographics
Get Instagram follower or engaged-audience demographics
Usage: smallforce social analytics instagram demographics [options] <accountId>
| Argument | Description |
|---|---|
accountId | Instagram account id from social accounts list |
| Option | Description |
|---|---|
--metric <value> | follower_demographics or engaged_audience_demographics |
--timeframe <value> | this_week or this_month |
--breakdown <value> | Provider-supported demographic breakdown |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics instagram demographics <accountId> \
--metric follower_demographics --timeframe this_month --json
smallforce social analytics youtube
YouTube channel and demographic analytics
smallforce social analytics youtube channel-insights
Get YouTube channel insights
Usage: smallforce social analytics youtube channel-insights [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics youtube channel-insights <accountId> --json
smallforce social analytics youtube demographics
Get YouTube channel demographics
Usage: smallforce social analytics youtube demographics [options] <accountId>
| Argument | Description |
|---|---|
accountId | YouTube account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--breakdown <value> | Provider-supported demographic breakdown |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics youtube demographics <accountId> --breakdown ageGroup --json
smallforce social analytics tiktok
TikTok account analytics
smallforce social analytics tiktok account-insights
Get TikTok account insights
Usage: smallforce social analytics tiktok account-insights [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics tiktok account-insights <accountId> --json
smallforce social analytics linkedin
LinkedIn aggregate and organization analytics
smallforce social analytics linkedin aggregate
Get LinkedIn aggregate analytics
Usage: smallforce social analytics linkedin aggregate [options] <accountId>
| Argument | Description |
|---|---|
accountId | LinkedIn account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names |
--aggregation <value> | TOTAL or DAILY |
Also accepts the common options listed at the top of this page.
Example:
$ smallforce social analytics linkedin aggregate <accountId> --aggregation DAILY --json
smallforce social analytics linkedin organization-aggregate
Get LinkedIn organization aggregate analytics
Usage: smallforce social analytics linkedin organization-aggregate [options] <accountId>
| Argument | Description |
|---|---|
accountId | Account id from social accounts list |
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Inclusive start date |
--to <YYYY-MM-DD> | Inclusive end date |
--metrics <csv> | Provider metric names as one comma-separated string |
--breakdown <value> | Provider-supported breakdown |
--metric-type <value> | time_series or total_value |
Also accepts the common options listed at the top of this page.
Metrics and breakdown values are provider-defined. Use --json to preserve the
complete provider payload. Provider-specific date limits may be narrower than
the general 366-day analytics window.
Example:
$ smallforce social analytics linkedin organization-aggregate <accountId> --json