Skip to main content
PUT
/
api
/
v1
/
users
/
{username}
cURL
curl --request PUT \
  --url https://api.myaifrontdeskdashboard.com/api/v1/users/{username} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "greetingPhrase": "Hi, welcome to My AI Frondesk. We're currently doing a 10% off summer sale. I can help you book an appointment or answer any questions you may have. How may I help you?",
  "reservedNum": 13456788989,
  "businessInformation": "Prestige Estates Realty is a dynamic player in the real estate industry, specializing in residential and commercial property transactions. With a commitment to excellence and customer satisfaction, we offer a comprehensive range of services, including property sales, leasing, and property management.\n\nOur team of experienced real estate professionals leverages market insights and cutting-edge technology to provide clients with tailored solutions that meet their unique needs. Whether you're buying, selling, or renting, ABC Realty is dedicated to delivering exceptional results and ensuring a seamless real estate experience.\n\nTo explore our available properties, list your property with us, or discuss your real estate goals, please visit our website or get in touch with our knowledgeable team.\n\nServices offered:\n- Property sales\n- Leasing\n- Property management\n- Market insights\n\nPrices:\n- Property sales: Starting from $200000\n- Leasing: Starting from $1000\n- Property management: Starting from $500\n- Market insights: Starting from $500",
  "emailAddress": "[email protected]",
  "businessName": "My AI Frontdesk",
  "sampleQA": "Q: What services do you offer? A: We offer haircuts, beard trims, hot towel shaves, and neck cleanups. Q: Do you have any availability right now? A: You can check for availability on our website.",
  "selectedLanguages": [
    "English, Hindi"
  ],
  "languageGreetings": {},
  "workflows": [
    {
      "description": "Send the caller a copy of the menu. Execute whenever caller asks for menu or prices.",
      "voiceResponse": "Here is our menu: www.restaurant.com/menu",
      "textMessage": "Great! I’ve just texted you a copy of the menu"
    }
  ],
  "callWorkflows": [
    {
      "description": "Transfer the caller to the billing department. Execute whenever caller asks for a refund or receipt.",
      "voiceResponse": "Sounds good, I am transferring you to the billing department right now. Please hold.\"",
      "workflowForwardingNumber": "+1xxxxxxxxxxx",
      "country": {
        "name": "Vietnam (+84)",
        "code": "+84"
      }
    }
  ],
  "voiceSelected": {
    "voiceId": "aura-asteria-en",
    "provider": "deepgram"
  },
  "chattiness": 35,
  "aiPrompt": "From now on, you are a helpful phone receptionist at My AI Frontdesk that customers can call to ask questions. Be friendly and helpful. Never make up information that you don't know.",
  "testingNumber": "+1xxxxxxxx",
  "businessType": "Other",
  "specialCommands": "Be extra polite",
  "endpointing": 300,
  "interruptionWords": 2,
  "extenstionDigits": {
    "extension": 1,
    "phoneNumber": "+1xxxxxxxxxx"
  },
  "voicemailsEnabled": true,
  "callNotifSettings": {
    "email_recipients": [
      "[email protected], [email protected]"
    ],
    "voicemail_enabled": true,
    "text_enabled": true,
    "call_enabled": false
  },
  "workflowNotifSettings": {
    "scenario": "If the caller mentions anything related to billing, refunds, or payments",
    "email_recipients": [
      "[email protected]"
    ]
  },
  "textingPlatformNotifSettings": {
    "enabled": true,
    "email_recipients": [
      "[email protected], [email protected]"
    ],
    "text_recipients": [
      "+1xxxxxxxxxx, +1xxxxxxxxxx"
    ]
  },
  "formBuilders": [
    {
      "description": "custom-scenario",
      "customScenario": "Anytime the user says I want to introduce my pet",
      "questions": [
        "What is your pet's name?"
      ],
      "final_collection_phrase": "Thanks, I have collected your information. Is there anything else I can help you with?"
    }
  ],
  "postCallWebhook": {
    "method": "POST",
    "endpoint": "https://www.example.com/"
  },
  "callWebhookWorkflows": [
    {
      "name": "Retieval worfflow",
      "scenario": "Trigger this webhook when the caller says book an appointment for me.",
      "isRepetable": false,
      "speechToEmit": "Great! Lets get your appointment booked.",
      "timeoutSeconds": 5,
      "webhookInformation": {
        "url": "https://www.example.com",
        "method": "POST",
        "headers": {
          "headerName": "<string>"
        },
        "body": {
          "key": "<string>"
        },
        "responseData": [
          {
            "jsonPath": "data.date",
            "variableName": "date",
            "prompt": "For which date should we book an appointment with you"
          }
        ]
      },
      "extractedCallInfo": [
        {
          "name": "date",
          "type": "string",
          "description": "This is the date on whhich they wish to book and appointment."
        }
      ]
    }
  ]
}
EOF
{
  "sucess": true,
  "message": "Receptionist updated successfully"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

username
string
required

username of the receptionist

Example:

"johndoe"

Body

application/json
greetingPhrase
string

Greeting phrase for the receptionist. It will say this phrase as it picks up the call

Example:

"Hi, welcome to My AI Frondesk. We're currently doing a 10% off summer sale. I can help you book an appointment or answer any questions you may have. How may I help you?"

reservedNum
string

Your twilio phone number which would receive calls

Example:

13456788989

businessInformation
string

Information about your business. This will be the knowledge base of the receptionist

Example:

"Prestige Estates Realty is a dynamic player in the real estate industry, specializing in residential and commercial property transactions. With a commitment to excellence and customer satisfaction, we offer a comprehensive range of services, including property sales, leasing, and property management.\n\nOur team of experienced real estate professionals leverages market insights and cutting-edge technology to provide clients with tailored solutions that meet their unique needs. Whether you're buying, selling, or renting, ABC Realty is dedicated to delivering exceptional results and ensuring a seamless real estate experience.\n\nTo explore our available properties, list your property with us, or discuss your real estate goals, please visit our website or get in touch with our knowledgeable team.\n\nServices offered:\n- Property sales\n- Leasing\n- Property management\n- Market insights\n\nPrices:\n- Property sales: Starting from $200000\n- Leasing: Starting from $1000\n- Property management: Starting from $500\n- Market insights: Starting from $500"

emailAddress
string<email>

Email address of the receptionist

businessName
string

Name of the business

Example:

"My AI Frontdesk"

sampleQA
string

Sample QA for your receptionist to train it according to real questions asked by the users and how to respond to them

Example:

"Q: What services do you offer? A: We offer haircuts, beard trims, hot towel shaves, and neck cleanups. Q: Do you have any availability right now? A: You can check for availability on our website."

selectedLanguages
string[]

Languages your receptionist will support (at-least English is mandatory/default)

languageGreetings
object

Greetings for all the languages provided in selectedLanguages (except for English, which uses greetingPhrase instead)

workflows
object[]
callWorkflows
object[]
voiceSelected
object
chattiness
integer
default:35
Required range: 0 <= x <= 100
aiPrompt
string
Example:

"From now on, you are a helpful phone receptionist at My AI Frontdesk that customers can call to ask questions. Be friendly and helpful. Never make up information that you don't know."

testingNumber
string
default:+1
Example:

"+1xxxxxxxx"

businessType
string
Example:

"Other"

specialCommands
string
Example:

"Be extra polite"

endpointing
integer
default:300
Required range: 0 <= x <= 1000
interruptionWords
integer
default:2
Required range: 0 <= x <= 15
extenstionDigits
object
voicemailsEnabled
boolean
Example:

true

callNotifSettings
object
workflowNotifSettings
object
textingPlatformNotifSettings
object
formBuilders
object[]

The AI will ask questions defined in the questions array in the beginning of the call (if scenario field is set to beginning) or if defined scenario occurs during the call (if scenario field is set to custom-scenario). Remember while using custom-scenario, the customScenario field is necessary.

postCallWebhook
object
callWebhookWorkflows
object[]

Response

success

sucess
boolean
Example:

true

message
string
Example:

"Receptionist updated successfully"