Create user
Users
Create user
Register a shared iMessage user on your project.
POST
Create user
Register a recipient phone number on your project’s shared iMessage pool. On the free plan, you can register up to 10 users per project.
Request
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
phoneNumber | string | Yes | E.164 phone number |
type | "shared" | Yes | Shared pool user (free tier) |
email | string | No | Optional contact email |
invite | boolean | No | Send an invite message when supported |
Response
linePhone is the shared-pool sender number assigned to this user.
Errors
| Code | Meaning |
|---|---|
409 | User already registered |
422 | Invalid phone number format |
403 | User cap reached (10 on free plan) |