3.0.0
Search…
⌃K
Links

Phone Numbers

This object represents a phone number in your instance.

Available requests

  • POST /v1/phone_numbers
  • GET /v1/phone_numbers/:id
  • PATCH/v1/phone_numbers/:id
  • DEL /v1/phone_numbers/:id

Example phone number schema

{
"id": "idn_2H2MoyJjUuDIQZLlafRppVIAG7T",
"object": "phone_number",
"phone_number": "+15555555555",
"reserved_for_second_factor": false,
"default_second_factor": false,
"reserved": false,
"verification": {
"status": "verified",
"strategy": "admin",
"attempts": null,
"expire_at": null
},
"linked_to": [],
"backup_codes": null
}
post
/v1/phone_numbers
Create a phone number
get
/v1/phone_numbers/{phone_number_id}
Get a phone number
patch
/v1/phone_numbers/{phone_number_id}
Update a phone number
delete
/v1/phone_numbers/{phone_number_id}
Delete a phone number