Update current user

Updates the authenticated user’s profile. Supports setting onboarding=false to mark onboarding as complete, and optionally recording use_case, referral, job_role and signup_metadata. The response reflects the current billing_blocked state, unaffected by this update. The response includes the caller’s team role: “admin”, “developer”, or "" for the account owner.

PATCH /users/me

Update current user

cURL

curl --request PATCH \
  --url https://api.social-api.ai/v1/users/me \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "job_role": "Founder / CEO",
  "lock_accounts_to_brand": true,
  "onboarding": false,
  "referral": "Google search",
  "signup_metadata": {},
  "use_case": "Managing my own brand's social accounts"
}
EOF

200

{
  "allowed_platforms": [
    "instagram",
    "facebook"
  ],
  "avatar_url": "https://example.com/avatar.jpg",
  "beta_tester": false,
  "billing_block_reason": "past_due",
  "billing_blocked": false,
  "billing_blocked_at": "<string>",
  "billing_currency": "usd",
  "email": "[e-mail]",
  "experiment_enrolled": false,
  "experiment_variant": "control",
  "facebook_page_selection": false,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "job_role": "Founder / CEO",
  "lock_accounts_to_brand": false,
  "onboarding": true,
  "plan": "free",
  "role": "admin",
  "signup_metadata": {},
  "use_case": "Managing clients' accounts (agency)"
}

Authorizations

Authorization · string · header · required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Body

application/json

Fields to update

job_role · string

JobRole records what best describes the user. Surrounding whitespace is trimmed, an empty value leaves the current one unchanged, and values longer than 120 characters are truncated.

Example:

"Founder / CEO"

lock_accounts_to_brand · boolean

LockAccountsToBrand toggles whether a social account already connected to one brand may be re-connected (moved) to a different brand. When true, such a connect attempt is rejected with 409 account.already_linked.

Example:

true

onboarding · boolean

Example:

false

referral · string

Example:

"Google search"

signup_metadata · object

SignupMetadata adds keys to the signup answers on record: a shallow merge, so keys sent replace the same keys and others are kept. At most 4096 bytes once encoded.

Show child attributes

use_case · string

Example:

"Managing my own brand's social accounts"

Response

200

application/json

Updated user profile

allowed_platforms · string[]

Example:

["instagram", "facebook"]

avatar_url · string

Example:

"https://example.com/avatar.jpg"

beta_tester · boolean

Example:

false

billing_block_reason · string

BillingBlockReason is why access is paused, empty when it is not. "past_due": a payment failed, and settling it restores access. "ban": the account was suspended for a Terms of Service violation. Paying does not lift it, and every route except this one returns 403 auth.suspended. Contact support to appeal.

Example:

"past_due"

billing_blocked · boolean

BillingBlocked is true when API access and webhook delivery are paused. Read BillingBlockReason to tell why and whether paying lifts it.

Example:

false

billing_blocked_at · string

BillingBlockedAt is when the block began, or null when not blocked.

billing_currency · string

BillingCurrency is the currency your subscription is billed in: "usd" or "eur". A subscription never changes currency, so plan changes are priced in it. Kept after a cancellation; "" when you never subscribed.

Example:

"usd"

email · string

Example:

"[e-mail]"

experiment_enrolled · boolean

ExperimentEnrolled is true only when ExperimentVariant was assigned by the experiment itself. False means the "control" above is a fallback (not enrolled, flag off, or evaluation failed) and must not be recorded as the caller's arm.

Example:

false

experiment_variant · string

ExperimentVariant is the caller's variant for staged feature rollouts: "control" or "treatment". "control" unless the caller is enrolled.

Example:

"control"

facebook_page_selection · boolean

FacebookPageSelection, when true, makes a Facebook connection (and an Instagram connection through Facebook Login) end with status=selection_required so you choose the Pages. Read-only.

Example:

false

id · string

Example:

"550e8400-e29b-41d4-a716-446655440000"

job_role · string

JobRole is what best describes the user, as answered during onboarding. Null until answered.

Example:

"Founder / CEO"

lock_accounts_to_brand · boolean

LockAccountsToBrand, when true, rejects connecting a social account that is already connected to another of your brands (409 account.already_linked) instead of moving it. Default false.

Example:

false

onboarding · boolean

Example:

true

plan · string

Example:

"free"

role · string

Role is the caller's team role: "admin", "developer", or "" for the account Owner, who holds no Role. An API key and an OAuth token both read "".

Example:

"admin"

signup_metadata · object

SignupMetadata holds open-ended answers recorded at signup, such as referral_source and search_query. An empty object until answered.

Show child attributes

use_case · string

Example:

"Managing clients' accounts (agency)"