Update user's phone number

Update a user’s phone number in an existing organization.

POST

/

public

/

v1

/

submit

/

update_user_phone_number

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.userId

string

required

Unique identifier for a given User.

parameters.userPhoneNumber

string

required

The user’s phone number in E.164 format e.g. [phone]. Setting this to an empty string will remove the user’s phone number.

parameters.verificationToken

string

Signed JWT containing a unique id, expiry, verification type, contact

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.updateUserPhoneNumberIntent

object

required

The updateUserPhoneNumberIntent object

Show updateUserPhoneNumberIntent details

activity.intent.updateUserPhoneNumberIntent.userId

string

required

Unique identifier for a given User.

activity.intent.updateUserPhoneNumberIntent.userPhoneNumber

string

required

The user’s phone number in E.164 format e.g. [phone]. Setting this to an empty string will remove the user’s phone number.

activity.intent.updateUserPhoneNumberIntent.verificationToken

string

Signed JWT containing a unique id, expiry, verification type, contact

activity.result

object

required

The result of the activity

Show result details

activity.result.updateUserPhoneNumberResult

object

required

The updateUserPhoneNumberResult object

Show updateUserPhoneNumberResult details

activity.result.updateUserPhoneNumberResult.userId

string

required

Unique identifier of the User whose phone number was updated.

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

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>"
    }
}'

200

{
  "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>"
      }
    }
  }
}