Internal API

Social posts

1 endpoint.

POST/api/v1/internal/social_posts/scheduled_publish

Publish Scheduled Social Post

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonSocialPostScheduledPublishBody

Field	Type	Description
`business_id`required	`string`
`social_post_id`required	`string`
`scheduled_at`required	`integer`

Responses

200Successful Response

application/jsonSuccessResponse_SocialPostScheduledPublishData_

Field Type Description

request_idrequired string

success true default true

datarequired

SocialPostScheduledPublishData

SocialPostScheduledPublishData fields

Field Type Description

social_post_idrequired string

statusrequired

enum | "skipped"

enum | "skipped" fields

enum

"skipped"

skipped boolean default false

reason string | null

result

SocialPostPublishResult | null

SocialPostPublishResult fields

Field	Type	Description
`social_post`required	`SocialPostData`	SocialPostData fields SocialPostData (not expanded)
`results`required	`SocialPostPublishTargetResult[]`	SocialPostPublishTargetResult[] fields Nested object (not expanded)
`success`required	`boolean`
`successful_count`required	`integer`
`failed_count`required	`integer`
`total_count`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.