Accounts

Updates a connected account's display name or username override.

X capabilities

For X accounts on usage-based billing, also accepts an xCapabilities object to toggle background API operations that incur X API pass-through costs.

  • Both fields are opt-in (default false).
  • When off, no analytics syncs or DM polling are performed for that account, and no API call is metered for those operations.
  • Publishing and deleting posts are always available regardless of these toggles.
  • Setting xCapabilities on a non-X account returns 400.

Meta ads sync

For Facebook accounts, also accepts metaAdsSyncEnabled to sync the Meta ads of the ad accounts the account reaches without a Meta Ads connection. See the field for what turning it on and off does.

put/v1/accounts/{accountId}

Request

Path parameters

accountIdstring required

Request body

usernamestring
displayNamestring
metaAdsSyncEnabledboolean

Facebook only (400 invalid_field_value on any other platform). Off by default for every Facebook account.

true makes this account sync the Meta ads of the ad accounts it reaches, like a metaads connection.

  • The first sync starts at once (14 days, then 90 days of history in the background) and fires account.ads.initial_sync_completed for this accountId with platform: metaads.
  • It then refreshes on the Meta Ads schedule.
  • Each switch from false to true runs another initial sync and fires the webhook again. Sending true while it is on changes nothing.
  • Needs ads_management and ads_read on the account (403 reconnect_required otherwise, with details.requiredPermissions).
  • Needs ads access (403 ads_addon_required) and room in the managed ads allowance (403 ads_allowance_exceeded).
  • While a metaads connection has this account as parentAccountId, that connection syncs the ads instead.

Synced active ads count on the managed ads meter like ads from a Meta Ads connection.

false stops the sync. Ads already synced are kept, never deleted: they stop updating and stop counting on the meter, and a metaads connection of yours that reaches the same ad account takes them over. Posting, inbox and comments on the account are not affected.

Response

Updated

messagestring
usernamestring
displayNamestring
metaAdsSyncEnabledboolean

The resulting setting, returned only when the request body included metaAdsSyncEnabled.

Changes

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • warning

      added the new account enum value to the / response property for the response status