CallFluent API: User Services
Published
User Services API
The User Services API enables users to manage their account details, password, profile settings, SMTP configuration, and branding preferences. These endpoints are essential for customizing your CallFluent experience at the user level.
18. Get User Profile
GET: /user/profile
Retrieves the current user’s profile details and custom branding settings.
Header
Authorization: Bearer {api_key}
Response
Example Success
Status code: 200: user detail with custom setting
{
"user": {
"name": "test",
"email": "[email protected]"
},
"setting": {
"website_name": "callfluent",
"website_description": "save time"
}
}
Errors
500 (Server Error) – Server error.
{
status: false,
error: error_message
}
19. Update User Detail
POST: /user/update-detail
Updates user-related details.
Header
Authorization: Bearer {api_key}
Path Parameter
Field | Type | Required | Description | Example |
---|---|---|---|---|
agent_id | number | true | Agent ID | 1 |
Request Body
{
data: webhookPayload
}
webhookPayload
Field | Type | Required | Description | Example |
---|---|---|---|---|
phone_number | string | true | International phone number | +1 234 5678910 |
[…custom fields] | string | false | Custom fields | name, email, address, etc. |
Response
Example Success
Status code: 200: agent list
{
status: true,
data: agent_list
}
Errors
500 (Server Error) – Server error.
{
status: false,
error: error_message
}
20. Reset User Password
POST: /user/reset-password
Updates the user’s password.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
oldPass: "123456",
newPass: "abcdefg"
}
}
data
Field | Type | Required | Description | Example |
---|---|---|---|---|
oldPass | string | true | Current password | 123456 |
newPass | string | true | New password | abcdefg |
Response
Example Success
Status code: 200
{ status: true }
Errors
{ status: false, msg: "Please input correct current password" }
21. Update User Setting
POST: /user/update-setting
Updates user branding and domain-level settings.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
userId: "12",
domain_name: "app.automation.ai",
website_logo: "https://google.com/1.jpg",
website_icon: "https://google.com/2.jpg",
support_desk_url: "https://google.com/help",
website_name: "Call Agent AI",
website_description: "AI is a game changer",
primary_color: "#0019FF"
}
}
data
Field | Type | Required | Description | Example |
---|---|---|---|---|
userId | string | true | User ID | 12 |
domain_name | string | false | Custom domain name | app.automation.ai |
website_logo | string | false | Custom logo (image/base64) | https://google.com/1.jpg |
website_icon | string | false | Custom icon (image/base64) | https://google.com/2.jpg |
support_desk_url | string | false | Support page link | https://google.com/help |
website_name | string | false | Custom site name | Call Agent AI |
website_description | string | false | Custom site description | AI is a game changer |
primary_color | string | false | Custom primary color | #0019FF |
Response
Example Success
Status code: 200
{ status: true }
Errors
- Something is wrong with your domain, please check if A record is added correctly.
domain_name
doesn’t point to23.29.127.132
correctly- Something went wrong
- To install domain isn’t failed
22. Update SMTP Setting
POST: /user/update-smtp-setting
Updates the SMTP configuration used for sending emails.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
userId: "12",
smtp_host: "gm.co",
smtp_port: "465",
smtp_username: "...",
smtp_password: "...",
from_name: "...",
from_email: "..."
}
}
data
Field | Type | Required | Description | Example |
---|---|---|---|---|
userId | string | true | User ID | 12 |
smtp_host | string | true | SMTP host | gm.co |
smtp_port | string | true | SMTP port | 465, 587 |
smtp_username | string | true | SMTP username | |
smtp_password | string | true | SMTP password | |
from_name | string | true | From name | |
from_email | string | true | From email address |
Response
Example Success
Status code: 200
{ status: true, user: updatedUserData }
Errors
{ status: false, error: "Something went wrong" }
Conclusion
This completes the User Services API section.
For workspace-wide features and automation flows, continue with the Workspace API Documentation.
Automate your phone calls with AI
Create artificial inteligence powered, human-like voice agents ready to handle inbound and outbound calls 24/7
Discover CallfluentFrequently asked questions
Get answers to commonly asked questions about our cutting-edge AI voice call technology & learn how our platform revolutionizes customer engagement line never before.
No, you don’t need to download or install anything. Callfluent is a cloud based app, that means that it is hosted in the cloud and you can access it from any device anytime.
Have more questions ? Check out our Knowledge base