Console API

Social profiles

3 endpoints.

GET/api/v1/admin/businesses/{business_id}/social_profiles

List social profiles for a business

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`platform`	query	`string`	Platform filter: all\|facebook\|instagram default "all"
`active`	query	`boolean \| null`	Optional active profile filter
`limit`	query	`integer`	default 50
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_SocialProfileData__

Field Type Description

request_idrequired string

success true default true

datarequired

SocialProfileData[]

SocialProfileData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`integration_connection_id`required	`string`
`platform`required	`enum`	one of "facebook", "instagram"
`profile_type`required	`enum`	one of "facebook_page", "instagram_business_account"
`connection_channel`	`enum`	one of "agency_business", "instagram_direct" · default "agency_business"
`posting_identity`	`enum`	one of "agency", "business" · default "agency"
`external_id`required	`string`
`parent_facebook_page_id`	`string \| null`
`direct_fallback_profile_id`	`string \| null`
`name`required	`string`
`username`	`string \| null`
`avatar_url`	`string \| null`
`external_permalink_url`	`string \| null`
`category`	`string \| null`
`display_name_override`	`string \| null`
`metadata`	`object`
`agency_publish_ready`	`boolean`	default false
`token_expires_at`	`integer \| null`
`token_last_validated_at`	`integer \| null`
`token_last_refreshed_at`	`integer \| null`
`token_last_error_code`	`string \| null`
`token_last_error_message`	`string \| null`
`active`required	`boolean`
`sort_order`required	`integer`
`created_at`required	`integer`
`updated_at`required	`integer`
`display_name`required	`string`	read-only

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.

PATCH/api/v1/admin/businesses/{business_id}/social_profiles/{profile_id}

Update local social profile settings

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`profile_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonSocialProfileUpdateBody

Field	Type	Description
`active`	`boolean \| null`
`sort_order`	`integer \| null`
`display_name_override`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_SocialProfileData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`SocialProfileData`	SocialProfileData fields SocialProfileData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/social_profiles/{profile_id}/refresh_token

Refresh a social profile publish token when supported

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`profile_id`required	path	`string (uuid)`
`required_valid_until`	query	`integer \| null`	Optional epoch time the token must remain valid through
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_SocialProfileTokenRefreshData_

Field Type Description

request_idrequired string

success true default true

datarequired

SocialProfileTokenRefreshData

SocialProfileTokenRefreshData fields

Field	Type	Description
`social_profile_id`required	`string`
`platform`required	`enum`	one of "facebook", "instagram"
`connection_channel`required	`enum`	one of "agency_business", "instagram_direct"
`refresh_supported`required	`boolean`
`refreshed`	`boolean`	default false
`reconnect_required`	`boolean`	default false
`token_expires_at`	`integer \| null`
`last_refreshed_at`	`integer \| null`
`message`	`string \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.