Accounts

Update a social account

patch/accounts/{account_id}

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/accounts/{account_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

account_idstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

aliasstring

Internal account label. An empty value clears it; omission preserves it.

messages_enabledboolean

Deprecated shim. Use POST /account-features to change messaging preference.

slugstring required

New account slug. Use lowercase letters, numbers, and hyphens.

Example request

{
  "$schema": "https://example.com/api/v1/schemas/UpdateAccountInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

account_avatar_urlstring required

Account avatar URL

account_idstring required

Platform-specific account ID

account_kindstring

Normalized identity kind, such as person, organization, creator, or business

account_usernamestring required

Account username

aliasstring

Internal account label. Does not change the provider identity.

capability_checked_atstring date-time

When account-specific publishing limits were last verified

fediverse_softwarestring

Detected Fediverse server software (mastodon, pixelfed, peertube, lemmy, piefed, or a compatible implementation)

grant_destination_countinteger required

Number of active destinations using this provider authorization

idstring required

Account ID

instance_urlstring required

Instance URL (Mastodon/Bluesky)

is_activeboolean required

Whether the account is active

limit_profile'standard' | 'x-premium'

Account-specific publishing limit profile

messages_enabledboolean required

Deprecated compatibility shim. Use GET /account-features for messaging enabled state.

messaging_supportedboolean required

Deprecated compatibility shim. Use GET /account-features for messaging availability and enabled state.

platformstring required

Platform name

provider_installation_idstring

Operator connector installation used by this account

shared_grantboolean required

Whether revoking this authorization disconnects other destinations

slugstring required

User-editable account slug for CLI selectors

thread_replies_supportedboolean required

Whether this account supports thread replies in current server config

Example response

{
  "$schema": "https://example.com/api/v1/schemas/AccountResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.