Skip to main content
POST
/
api
/
run
/
users
/
mutations
/
upsertUser
upsertUser
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/users/mutations/upsertUser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {
    "workosUserId": "org_user_123",
    "email": "member@example.com",
    "displayName": "Member Example",
    "orgId": "org_abc123",
    "orgRole": "member"
  }
}'
{
  "status": "success",
  "errorMessage": "",
  "errorData": {},
  "value": "user_9f3c2ab457"
}

Authorizations

Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
string

ID from table "users"