Skip to main content
POST
/
public
/
admin
/
phone-assignments
Assign phone to user
curl --request POST \
  --url https://web-api.clerk.chat/public/admin/phone-assignments \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "userId": "<string>",
  "phoneId": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clerk.chat/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
apiKey
string
header
required

Body

application/json

Request to assign a phone number to a user

​
userId
string
required

ID of the user to assign the phone to

​
phoneId
string
required

ID of the phone number to assign

Response

The user with assigned phone

Response containing user information

​
id
string
required

The ID of the user

​
name
string
required

The name of the user

​
email
string
required

The email of the user

​
phone
string

The assigned phone number