Inbox
Use UniPost Inbox APIs to bring supported comments, DMs, and response workflows into your own product. Today this covers Instagram comments and DMs, Threads comments, and YouTube comments, with more sources coming soon.
Availability
Statussupported
Inbox APIs are available for supported plans and are feature-flagged through UniPost feature flags.
Current supportig_comment, ig_dm, threads_reply, youtube_comment
Instagram comments and DMs, Threads comments, and YouTube comments are currently supported. More sources are coming soon.
Auth modelBearer <token>In header
Use a workspace API key or an authenticated dashboard token with workspace access.
Supported endpoints
GET /v1/inboxlist
List inbox items for the current workspace. Supports filters such as source and unread status.
GET /v1/inbox/unread-countread
Return the current unread item count for sidebar badges and notification surfaces.
POST /v1/inbox/syncsync
Trigger a manual sync for connected accounts that support inbox polling.
GET /v1/inbox/{id}read
Fetch a single normalized inbox item.
POST /v1/inbox/{id}/replywrite
Reply to a supported comment, DM, or thread from your product.
POST /v1/inbox/{id}/thread-stateworkflow
Update workflow state such as open, assigned, or resolved.
Supported sources
ig_commentsupported
Comments on connected Instagram Business or Creator accounts.
ig_dmsupported
Instagram DMs when the connected account and permissions are eligible.
threads_replysupported
Comments and replies on connected Threads content.
youtube_commentsupported
Comments on connected YouTube video content.
more_sourcescoming soon
Additional inbox sources and workflow coverage will be added over time.
Query params
source?string
Filter by normalized source.
Valuesig_comment | ig_dm | threads_reply | youtube_comment
is_read?boolean
Filter unread or read items.
is_own?boolean
Filter items authored by the connected account or by an external user.
limit?integer
Maximum number of items to return. Defaults to 50 and caps at 500.
Response
200 OK
data[]array
Normalized inbox items sorted by received_at descending.
data[].idstring
Stable UniPost inbox item identifier.
data[].sourcestring
Normalized source such as ig_comment, ig_dm, threads_reply, or youtube_comment.
data[].social_account_idstring
Connected account that owns the item.
data[].thread_keystring
Stable key used to group related messages and replies.
data[].thread_statusstring
Workflow state.
Valuesopen | assigned | resolved
data[].author_namestring
Best available author display name.
data[].bodystring
Comment or message body.
data[].is_readboolean
Whether the item has been read in UniPost.
data[].is_ownboolean
Whether the item was authored by the connected account.
data[].received_atstring
Inbound or outbound activity timestamp.
request_idstring
Request identifier for debugging and support.
Errors
error.codestring
UNAUTHORIZED, PLAN_FEATURE_NOT_AVAILABLE, FEATURE_DISABLED, or VALIDATION_ERROR.
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.