clerk.create_phone_number
Create a phone number for a Clerk user.
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 created phone number summary.
Cost = 10 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| primary | No | Whether this should be the user's primary phone number. | |
| user_id | Yes | Clerk user id (user_...) to retrieve or modify. | |
| verified | No | Whether the phone number should be marked verified. Defaults to false. | |
| phone_number | Yes | Phone number in E.164 format (e.g. +15551234567). | |
| 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 | Created Clerk phone number object from the Backend API. |