Skip to main content
PUT
Upsert one social account

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

platform
enum<string>
required

Supported social platform; unknown keys return 422.

Available options:
facebook,
instagram,
x,
linkedin,
whatsapp,
wechat,
youtube,
tiktok,
pinterest
Example:

"x"

Body

application/json

Exactly one handle or full HTTP(S) profile URL for the selected platform.

handle
string
required

Account handle; WhatsApp uses international digits with an optional leading plus. YouTube also accepts channel/, c/, and user/ paths.

Required string length: 1 - 255
Pattern: \S
Example:

"rae_kim"

url
string

Full profile URL on the selected platform. Unsupported paths, query strings, fragments, credentials and custom ports are refused.

Required string length: 1 - 2048
Example:

"https://x.com/rae_kim"

Response

The saved social account.

data
object
required

A shared-user social account. Blank platforms are omitted from the collection.

meta
object
required

Envelope metadata present on every response.