v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
People

Create a phone number for a person

Add a new phone number to an existing person

post/v1/people/{person_id}/phone_numbers

Request body

phone_numberstring
extensionstring
phone_type'mobile' | 'work' | 'home' | 'fax' | 'other'
is_primaryboolean

Example request

{
  "phone_number": "+15555551234",
  "extension": "1234",
  "phone_type": "mobile",
  "is_primary": true
}

Response

phone number created

idstring
person_idstring
phone_numberstring
extensionstring nullable
phone_typestring
is_primaryboolean