Skip to main content
POST
/
core.v1.UserService
/
CreateUserExternalId
cURL
curl -X POST "https://api.joinformal.com/core.v1.UserService/CreateUserExternalId" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "externalId": {
    "id": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "appId": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
userId
string
Minimum string length: 1
externalId
string
Minimum string length: 1
description
string
appId
string

Response

Success

externalId
external_id · object