Skip to main content
POST
/
api
/
v1
/
users
cURL
curl --request POST \
  --url https://api.myaifrontdeskdashboard.com/api/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 123,
  "name": "<string>",
  "emailAddress": "<string>",
  "businessName": "<string>",
  "businessType": "<string>",
  "greetingPhrase": "<string>",
  "selectedLanguages": [
    "<string>"
  ],
  "languageGreetings": {},
  "workflows": [
    {
      "description": "<string>",
      "voiceResponse": "<string>",
      "textMessage": "<string>"
    }
  ],
  "callWorkflows": [
    {
      "description": "<string>",
      "voiceResponse": "<string>",
      "workflowForwardingNumber": "<string>",
      "country": {
        "name": "<string>",
        "code": "<string>"
      }
    }
  ],
  "voiceSelected": {
    "voiceId": "<string>",
    "provider": "<string>"
  },
  "chattiness": 50,
  "aiPrompt": "<string>",
  "testingNumber": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "emailAddress": "<string>",
  "businessName": "<string>",
  "businessType": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Receptionist's default configuration

id
integer<int64>
required

Identification number of the receptionist

name
string
required

Name of the receptionist

emailAddress
string
required

Email address of the receptionist

businessName
string
required

Name of the business

businessType
string
required

Type of the business

greetingPhrase
string
required

Greeting phrase for the receptionist

selectedLanguages
string[]

Languages spoken by the receptionist

languageGreetings
object

Greetings in different languages

workflows
object[]

List of workflows

callWorkflows
object[]

List of call workflows

voiceSelected
object

Voice selection details

chattiness
integer

Chattiness level of the receptionist

Required range: 0 <= x <= 100
aiPrompt
string

AI prompt for the receptionist

testingNumber
string

Testing number for the receptionist

Response

Receptionist response

id
integer<int64>
required

Identification number of the receptionist

name
string
required

Name of the receptionist

emailAddress
string
required

Email address of the receptionist

businessName
string
required

Name of the business

businessType
string
required

Type of the business