REST API
Socials
Social object

Social object

Social

The social object is returned by the socials endpoints and shares the same id and platform semantics used in post account payloads.

The id and platform values returned by /socials match the objects used in Post.accounts. You can pass those IDs directly when creating or updating posts.

FieldTypeDescription
idstringSocial account identifier. Matches Post.accounts[].id.
platformstringPlatform name. Matches Post.accounts[].platform.
display_namestringDisplay name for the connected social profile.
handlestring | nullHandle or username when available.
avatar_urlstring | nullAvatar image URL when available.
statusactive | failedCurrent account status in the public API context.
error_messagestring | nullUser-facing failure reason when status is failed. Otherwise null.