API Key
Webauthn (Passkey)
Body
Enum options: ACTIVITY_TYPE_UPDATE_USER
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Unique identifier for a given User.
Human-readable name for a User.
The user’s email address.
An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.
Array item type: string
item field
parameters.userPhoneNumber
The user’s phone number in E.164 format e.g. +13214567890
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
The intent of the activity
activity.intent.updateUserIntent
The updateUserIntent objectShow updateUserIntent details
activity.intent.updateUserIntent.userId
Unique identifier for a given User.
activity.intent.updateUserIntent.userName
Human-readable name for a User.
activity.intent.updateUserIntent.userEmail
The user’s email address.
activity.intent.updateUserIntent.userTagIds
An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.
activity.intent.updateUserIntent.userTagIds.item
activity.intent.updateUserIntent.userPhoneNumber
The user’s phone number in E.164 format e.g. +13214567890
The result of the activity
activity.result.updateUserResult
The updateUserResult objectShow updateUserResult details
activity.result.updateUserResult.userId
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/update_user \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"type": "ACTIVITY_TYPE_UPDATE_USER",
"timestampMs": "<string> (e.g., 1745474677473)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string_element>"
],
"userPhoneNumber": "<string>"
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UPDATE_USER",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677473)",
"result": {
"activity": {
"type": "<string>",
"intent": {
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string_element>"
],
"userPhoneNumber": "<string>"
}
},
"result": {
"updateUserResult": {
"userId": "<string>"
}
}
}
}
}
}