Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 3.08 KB

File metadata and controls

53 lines (41 loc) · 3.08 KB

SocialAccount

Properties

Name Type Description Notes
id String [optional]
platform PlatformEnum [optional]
profileId SocialAccountProfileId [optional]
username String [optional]
displayName String [optional]
profilePicture String URL to the account's profile picture on the platform. May be null if the platform does not provide one. [optional]
profileUrl String Full profile URL for the connected account on its platform. [optional]
isActive Boolean [optional]
followersCount BigDecimal Follower count (only included if user has analytics add-on) [optional]
followersLastUpdated OffsetDateTime Last time follower count was updated (only included if user has analytics add-on) [optional]
parentAccountId String Reference to the parent posting SocialAccount. Set for ads accounts that share or derive from a posting account's OAuth token. null for standalone ads (Google Ads) and all posting accounts. [optional]
enabled Boolean Whether the user explicitly activated this account. false means the account was created as a side effect (e.g., posting account auto-created when user connected ads first). Posting UI and scheduler ignore accounts with enabled: false. [optional]
metadata Object Platform-specific metadata. Fields vary by platform. For WhatsApp accounts, includes: - qualityRating: Phone number quality rating from Meta (GREEN, YELLOW, RED, or UNKNOWN) - nameStatus: Display name review status (APPROVED, PENDING_REVIEW, DECLINED, or NONE). Messages cannot be sent until the display name is approved by Meta. - messagingLimitTier: Maximum unique business-initiated conversations per 24h rolling window (TIER_250, TIER_1K, TIER_10K, TIER_100K, or TIER_UNLIMITED). Scales automatically as quality rating improves. - verifiedName: Meta-verified business display name - displayPhoneNumber: Formatted phone number (e.g., "+1 555-123-4567") - wabaId: WhatsApp Business Account ID - phoneNumberId: Meta phone number ID [optional]

Enum: PlatformEnum

Name Value
TIKTOK "tiktok"
INSTAGRAM "instagram"
FACEBOOK "facebook"
YOUTUBE "youtube"
LINKEDIN "linkedin"
TWITTER "twitter"
THREADS "threads"
PINTEREST "pinterest"
REDDIT "reddit"
BLUESKY "bluesky"
GOOGLEBUSINESS "googlebusiness"
TELEGRAM "telegram"
SNAPCHAT "snapchat"
DISCORD "discord"
WHATSAPP "whatsapp"
LINKEDINADS "linkedinads"
METAADS "metaads"
PINTERESTADS "pinterestads"
TIKTOKADS "tiktokads"
XADS "xads"
GOOGLEADS "googleads"