If you need to update information for a specific user in your organization, you can use the following API endpoint:
Endpoint: PATCH /users/{user-uuid}/
Payload Parameters:
-
full_name
: User's full name. -
occupation
: Job title for this user in the organization. -
birth_date
: Birth date of the user with MM-DD format. -
is_active
: [Boolean] Determines whether the user is active in the organization. -
bot_enabled
: [Boolean] Determines whether the user has enabled the bot on the chat. -
timezone
: [String] User’s time zone. -
work_days
: [Numeric list] Work days in the organization (only available if the organization allows members to set their work days). -
timeoff_start
: [String] Start date of time off. -
timeoff_end
: [String] End date of time off. -
hour_init_work
: [String] Work start time in HH:MM:SS format.
Request Example:
"full_name":"John Wick",
"occupation":"Teammate",
"birth_date":"10-26",
"is_active": true,
"bot_enabled": true,
"timezone": "America/New_York",
"work_days": [1, 2, 3, 4, 5],
"timeoff_start": "2023-03-12",
"timeoff_end": "2023-03-18",
"hour_init_work": "09:00:00"
}
Response Example:
- None
How to Use:
-
Access the User Information Update Endpoint: Utilize the
PATCH
method on/users/{user-uuid}/
to update specific information for a user identified by their UUID. -
Provide Updated Information: In the request body, include the fields you want to update with the new values. For example, you can change the user's full name, occupation, birth date, activity status, bot-enabled status, timezone, work days, time-off details, and work start time.
-
Update Successful: The API will process the request, and if successful, the user's information will be updated accordingly.
Feel free to use this API endpoint to keep user information up-to-date within your organization. If you have further questions or need assistance, please contact our support team at support@dailybot.com.
Comments
0 comments
Article is closed for comments.