curl --request POST \
--url https://api.turnkey.com/public/v1/submit/update_user_phone_number \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"userId": "<string>",
"userPhoneNumber": "<string>",
"verificationToken": "<string>"
}
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().updateUserPhoneNumber({
userId: "<string> (Unique identifier for a given User.)",
userPhoneNumber: "<string> (The user's phone number in E.164 format e.g. +13214567890. Setting this to an empty string will remove the user's phone number.)",
verificationToken: "<string> (Signed JWT containing a unique id, expiry, verification type, contact)"
});
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"updateUserPhoneNumberIntent": {
"userId": "<string>",
"userPhoneNumber": "<string>",
"verificationToken": "<string>"
}
},
"result": {
"updateUserPhoneNumberResult": {
"userId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
Activities
Update user's phone number
Update a user’s phone number in an existing organization.
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/update_user_phone_number \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"userId": "<string>",
"userPhoneNumber": "<string>",
"verificationToken": "<string>"
}
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().updateUserPhoneNumber({
userId: "<string> (Unique identifier for a given User.)",
userPhoneNumber: "<string> (The user's phone number in E.164 format e.g. +13214567890. Setting this to an empty string will remove the user's phone number.)",
verificationToken: "<string> (Signed JWT containing a unique id, expiry, verification type, contact)"
});
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"updateUserPhoneNumberIntent": {
"userId": "<string>",
"userPhoneNumber": "<string>",
"verificationToken": "<string>"
}
},
"result": {
"updateUserPhoneNumberResult": {
"userId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
A successful response returns the following fields:
Was this page helpful?