Start here
Socialize API guides explain how to find the intended workspace and campaign, interpret results, and verify a reviewed operation. For a product introduction, see Socialize.
Brand profiles and members
- Create a Socialize brand workspace: Create an Auth-owned workspace and its Socialize profile, then reconcile both sides before retrying an uncertain result.
- List accessible Socialize brands: Find the caller’s authorized workspace profiles and understand membership reconciliation and cached counts.
- Get a Socialize brand profile: Read one authorized workspace’s Socialize profile without mistaking local profile fields for Auth identity.
- List Socialize brand members: Read the app’s local member roster and distinguish user identities, pending members and platform grants.
- Update a Socialize brand profile: Edit description or logo with explicit local-role checks, partial-write recovery and Auth-owned naming.
Campaign discovery
- Get a Socialize campaign: Read one campaign, check its brand boundary, and interpret its variants, schedule window and current status.
- List Socialize campaigns: Find campaigns in one authorized workspace using creator/status filters and offset pagination.
Create and schedule
-
Create a campaign: Start with a draft and optional local draft content; review any scheduled-creation effects.
-
Schedule a campaign: Review the window, stored template/platform cadence, queued occurrence posts and partial-write recovery.
-
Update a Socialize campaign: Edit campaign fields or replace intended draft variants while keeping lifecycle effects and partial-write recovery explicit.
Connection readiness
- Check publishing readiness for the brand’s platform connections. This inspects connection metadata; it does not test a provider publish.
Campaign lifecycle
-
Activate a Socialize campaign: Move an authorized scheduled campaign to active while its scheduling window is open.
-
Cancel a Socialize campaign: Mark a draft, scheduled or active campaign cancelled without assuming that provider content has been withdrawn.
-
Pause a Socialize campaign: Pause an active or scheduled campaign while retaining its campaign status.
-
Resume a Socialize campaign: Clear the pause flag on an authorized paused campaign without changing its campaign status.
-
Complete a campaign: Mark an active campaign completed and verify stored state separately from notification delivery.
Personal preferences
- Read your Socialize preferences: Read your notification/display preferences and distinguish computed defaults from stored settings.
- Update your Socialize timezone preference: Change the original caller’s stored timezone while recognizing the current action’s unsupported advertised settings.
Posts
- List Socialize posts: Find stored posts using workspace, platform, author, campaign, thread and status filters; distinguish stored failures and page counts from provider state and total counts.
Voice presets and change history
- List built-in Socialize voice templates: Inspect the shipped voice templates, their full settings and the distinction between templates and saved brand presets.
- Get a saved Socialize voice preset: Read one persisted voice preset and distinguish missing records, workspace ownership and shipped templates.
- Get the default Socialize voice preset: Read the saved default for one authorized workspace, including the explicit no-default result.
- List saved Socialize voice presets and templates: Distinguish saved workspace voices from appended shipped templates and understand their different response projections.
- Read the Socialize voice-preset audit log: Inspect recent stored preset-change audit rows for one authorized workspace without mistaking them for provider or complete history proof.
Dashboard and account authorization
- Read Socialize dashboard metrics: Interpret authorized workspace counts, empty states, template controls and dependency errors without inferring provider delivery.
- Prepare a social account authorization: Prepare an intended OAuth link with explicit scope, partial-state recovery and separate consent/connection verification.
Work in the correct brand
A brand is an Auth-owned workspace. Discover the actual workspace grant with the original credential and keep resource selection separate from action input. Reading a guide does not grant permission or approve a mutation. Authorization may synchronize the app-local brand mirror; consult the action guide’s effects before describing a read as zero-write.
Contracts and examples
The action explorer exposes the current credential-visible action contract. Use each task guide for source-specific meaning, worked examples, persistence limits and recovery. The catalogue can contain structural response schemas; the guide explains the actual reviewed handler shape. All examples on the linked guides are synthetic and unrun unless explicitly labelled otherwise.
Change log
-
2026-10-21: Added a focused Socialize API entry linking campaign discovery, publishing readiness and four lifecycle guides. Source-qualified examples, brand authorization effects and current-declaration comparisons are recorded in the individual immutable guide versions. This entry is not a claim that every Socialize action is documented or that source-to-serving deployment is verified.
-
2026-10-21: Linked the accepted creation, scheduling and completion guides after their exact native/public publication checks. The existing seven links and Applications overview remain available.
-
2026-10-21: Linked campaign editing and four reviewed brand/profile/member guides after their native/public publication checks. These distinguish local profile/membership state, Auth workspace identity, read-side reconciliation and caching, and approved description/logo editing. Earlier links and historical entries are retained.
-
2026-10-21: Linked canonical brand creation and the two personal-preference guides after verified native/public publication. Existing fifteen links and history are preserved; preference guides distinguish the supported timezone edit from advertised settings not persisted by the reviewed handler.
-
2026-10-21: Linked the post-list guide after native/public publication verification. This guide explains stored-post filters, failure-status projection and offset-pagination limits; it does not claim live provider reconciliation.
-
2026-10-21: Linked five voice-template, saved-preset and audit guides after native/public publication checks. These distinguish shipped templates, stored workspace defaults, returned field projections, the ignored preset-list limit, read-time template timestamps and raw recent audit records.
-
2026-10-21: Linked dashboard metrics and account-authorization preparation after exact native/public publication checks. Dashboard counts are scoped stored-state observations; an OAuth start is not consent, a connected account or delivery proof. Previous twenty-four links and historical notes are retained.