Hanzo
OpenapiSocial

Records a social account for the org and answers 201 with the stored row,…

Records a social account for the org and answers 201 with the stored row, including the generated id later calls address it by.

POST /v1/social/accounts

Addresshttps://api.hanzo.ai/v1/social/accounts
MethodPOST
Operationpost_social_accounts
AuthAuthorization: Bearer $HANZO_API_KEY

Records a social account for the org and answers 201 with the stored row, including the generated id later calls address it by.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
handlebodystringHandle is the account's public name on the network, as the customer knows it (@acme).
providerbodystringProvider is the network this account is on: x, facebook, instagram, linkedin, tiktok, youtube or threads. Omitted means x.
statusbodystringStatus is the connection lifecycle: connected, disconnected or error.

Response

StatusBodyMeaning
201socialAccountcreated

201 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 create

Social API · All Hanzo APIs · Interactive reference

How is this guide?

On this page