clerk.update_phone_number
Update a Clerk phone number by id.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the updated phone number summary.
Cost = 8 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| primary | No | Whether this should be the user's primary phone number. | |
| verified | No | Whether the phone number should be marked verified. | |
| phone_number_id | Yes | Clerk phone number id (idn_... or phn_...) to retrieve or modify. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. | |
| reserved_for_second_factor | No | Whether to reserve this number for multi-factor authentication. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phone_number | No | Updated Clerk phone number object from the Backend API. |