Hanzo
OpenapiSocial

Replaces the account's network, handle and status with what the body carries,…

Replaces the account's network, handle and status with what the body carries, and answers with the stored row.

PUT /v1/social/accounts/{id}

Addresshttps://api.hanzo.ai/v1/social/accounts/{id}
MethodPUT
Operationput_social_accounts_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Replaces the account's network, handle and status with what the body carries, and answers with the stored row.

This is a REPLACEMENT, not a merge, which is the rule most easily got wrong: a field the body omits is written as its default, so leaving out the handle blanks it and leaving out the status resets it to connected. Send the whole record. The same vocabularies as create apply, and an unknown network or status is refused rather than coerced.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyes
handlebodystringHandle is the account's public name on the network.
providerbodystringProvider is the network this account is on: x, facebook, instagram, linkedin, tiktok, youtube or threads.
statusbodystringStatus is the connection lifecycle: connected, disconnected or error.

Response

StatusBodyMeaning
200socialAccountok

200 body — 6 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is when the account was connected, as a unix timestamp in seconds.
handlebodystringHandle is the account's public name on the network, as the customer knows it.
idbodystringID is the account's identifier, minted on connect and the id every later call addresses it by.
providerbodystringProvider is the network this account is on: x, facebook, instagram, linkedin, tiktok, youtube or threads.
statusbodystringStatus is the connection lifecycle: connected, disconnected or error.
updatedAtbodyintegerUpdatedAt is when the account row last changed, as a unix timestamp in seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo social accounts set <id>

Social API · All Hanzo APIs · Interactive reference

How is this guide?

On this page