Console API
Social posts
13 endpoints.
/api/v1/admin/businesses/{business_id}/social_postsList social posts for a business
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
status | query | string | Status filter: all|draft|queued|published|failed default "all" |
platform | query | string | Platform filter: all|facebook|instagram default "all" |
search | query | string | null | Search post content |
cursor | query | string | null | |
direction | query | string | Pagination direction: next|prev default "next" |
limit | query | integer | default 30 |
from_date | query | string | null | Optional scheduled/published lower bound as YYYY-MM-DD |
to_date | query | string | null | Optional scheduled/published upper bound as YYYY-MM-DD |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_SocialPostListItemData__| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostListItemData[] | SocialPostListItemData[] fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fields
|
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_postsCreate a social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonSocialPostWriteBody| Field | Type | Description |
|---|---|---|
content_markdownrequired | string | max length 5000 |
link_url | string | null | |
photo_ids | string[] | max items 10string[] fields |
target_profile_ids | string[] | string[] fields |
target_formats | SocialPostTargetFormatBody[] | SocialPostTargetFormatBody[] fieldsSocialPostTargetFormatBody, expanded above. |
publish_mode | enum | one of "draft", "publish_now", "schedule" · default "draft" |
scheduled_at | integer | null | |
timezone | string | null | |
workflow_run_id | string | null | |
thread_id | string | null | |
media_status | string | null |
Responses
201Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialPostData | SocialPostData fieldsSocialPostData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}Get a social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostData | SocialPostData fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}Update a social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonSocialPostWriteBodySocialPostWriteBody, expanded above.
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialPostData | SocialPostData fieldsSocialPostData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}Delete a social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
204Successful Response400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}/previewPreview a social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonSocialPostPreviewBody| Field | Type | Description |
|---|---|---|
surfacerequired | enum | one of "facebook_feed", "facebook_carousel", "instagram_feed", "instagram_carousel" |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostPreviewData_| Field | Type | Description | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||
datarequired | SocialPostPreviewData | SocialPostPreviewData fields
| |||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}/publishPublish a social post immediately
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Request bodyrequired
application/jsonSocialPostPublishBody| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
target_profile_ids | string[] | string[] fields | |||||||||
target_formats | SocialPostTargetFormatBody[] | SocialPostTargetFormatBody[] fields
|
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostPublishResult_| Field | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||
datarequired | SocialPostPublishResult | SocialPostPublishResult fields
| |||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}/syncSync one post from Meta now (targeted re-read — catches IG edits)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialFeedSyncData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialFeedSyncData | SocialFeedSyncData fieldsSocialFeedSyncData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/{social_post_id}/sync_engagementRefresh engagement metrics for a published social post
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
social_post_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialEngagementSyncData_| Field | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||
success | true | default true | |||||||||||||||
datarequired | SocialEngagementSyncData | SocialEngagementSyncData fields
| |||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/calendar_eventsList social post calendar events
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
from_date | query | string | null | Optional lower bound as YYYY-MM-DD |
to_date | query | string | null | Optional upper bound as YYYY-MM-DD |
platform | query | string | Platform filter: all|facebook|instagram default "all" |
status | query | string | Status filter: all|queued|published|failed default "all" |
cursor | query | string | null | |
limit | query | integer | default 200 |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_list_SocialPostCalendarEventData__| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostCalendarEventData[] | SocialPostCalendarEventData[] fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/full_syncAdmin: deep full sync of all feeds (re-reads every post, catches edits)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialFeedSyncData_| Field | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||
success | true | default true | |||||||||
datarequired | SocialFeedSyncData | SocialFeedSyncData fields
| |||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/generateGenerate editable social post content
Generate a caption -- through the workflow when it is enabled.
The workflow path persists the draft (and its photos) and returns it, so the console navigates into an existing post. The inline path returns a caption and nothing else, which is what it has always done.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
Idempotency-Key | header | string | null | |
X-Workflow-Bypass | header | string | null | |
authorization | header | string | null |
Request bodyrequired
application/jsonSocialPostGenerateBody| Field | Type | Description |
|---|---|---|
prompt | string | null | |
target_profile_ids | string[] | string[] fields |
platforms | enum[] | enum[] fields |
provider | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialPostGenerateData_| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request_idrequired | string | ||||||||||||||||||||||||||||||||||||||||
success | true | default true | |||||||||||||||||||||||||||||||||||||||
datarequired | SocialPostGenerateData | SocialPostGenerateData fields
| |||||||||||||||||||||||||||||||||||||||
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. | |||||||||||||||||||||||||||||||||||||||
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.
/api/v1/admin/businesses/{business_id}/social_posts/syncSync all connected feeds now (incremental delta from Meta)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
business_idrequired | path | string (uuid) | |
authorization | header | string | null |
Responses
200Successful Responseapplication/jsonSuccessResponse_SocialFeedSyncData_| Field | Type | Description |
|---|---|---|
request_idrequired | string | |
success | true | default true |
datarequired | SocialFeedSyncData | SocialFeedSyncData fieldsSocialFeedSyncData, expanded above. |
metadata | ResponseMetadata | null | ResponseMetadata fieldsResponseMetadata, expanded above. |
meta | ResponseMeta | null | ResponseMeta fieldsResponseMeta, expanded above. |
400Bad request401Unauthorized403Forbidden404Not found422Validation error500Internal server error503Service unavailable
Error bodies: ErrorResponse. See Errors.