v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Phone number input

Add phone

Add phone to interview. Deprecated, use POST /phone instead.

post/omni/add/phone

Headers

api-versionstring required

Request body

phonestring

User's phone number. E.164 number convention.

optInGrantedboolean

Indicates whether opt-in is granted

Example request

{
  "phone": "+1111111"
}

Response

OK

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status

existingCustomerboolean

Flag indicating if this user with given phone already exists in the system.