Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Update password
Search
JUMP TO
Uspacy api
Introduction
SDKs and boilerplates
authService
Sign in
post
Confirm user email
post
Refresh token
post
New user registration by invitation
post
Sign up
post
Initiate password reset
post
Change password with token
post
Update user password
patch
Update password
patch
Email existence check
get
usersService
Get users list
get
Get user by id
get
Update user data by id.
patch
Deactivate user by id
post
Activate user by id
post
Update user roles by id. Returns user data with new roles
patch
Update user position by id. Returns user data with new position
patch
Get user account settings by id.
get
Update user account settings by id.
patch
Get two-factor authentication status by id.
get
Disable two-factor authentication by id.
patch
Get self profile
get
Get two-factor authentication status
get
Enable two-factor authentication in a two steps
patch
Disable two-factor authentication
patch
Search
get
Avatar upload
post
Getting a list of users by filter. Available to unauthorized users.
post
Get self settings
get
Update self settings
patch
departments (usersService)
Get departments list
get
Create department.
post
Get department by id
get
Update department by id
patch
Delete department
delete
Update department roles by id. Returns department data with new roles
patch
Update department users by id.
patch
Delete users from department
patch
roles (usersService)
Get permissions list.
get
Get roles list.
get
Create role.
post
Get role by id
get
Update role by id
patch
Delete role by id
delete
invite (usersService)
Checking if an invitation exists.
get
Create invites.
post
Create invites.
post
Resend an invitation
patch
Delete invitation
delete
custom fields (usersService)
Get available fields list.
get
Create field.
post
Get field by code.
get
Edit field by code.
patch
Delete field by code.
delete
Get list elements. Available for all users.
get
Creating or editing list items.
post
Deleting a list item.
delete
Get field sections list.
get
incoming webhooks (usersService)
Retrieve Incoming Webhooks List
get
Create Incoming Webhook
post
Mass Delete Incoming Webhooks
delete
Update Incoming Webhook
patch
Delete Incoming Webhook
delete
outgoing webhooks (usersService)
Retrieve Outgoing Webhooks List
get
Create a New Outgoing Webhook
post
Delete Multiple Outgoing Webhooks
delete
Delete an Outgoing Webhook
delete
Toggle Outgoing Webhook Status
patch
Repeat Outgoing Webhook Action
patch
newsFeedService
Get posts list
get
Create post
post
Update post
patch
Delete post
delete
tasksService
Get available tasks list
get
Create task
post
Get task by id
get
Edit task by id
patch
Delete task by id
delete
Get kanban stages
get
Create kanban stage
post
Get kanban stage by id
get
Update kanban stage by id
patch
Delete kanban stage by id
delete
Moving a task to stage
post
Get checklist by task id
get
Create checklist for task
post
Update checklist for task
patch
Delete checklist from task by id
delete
Get checklist items by id
get
Create checklist for task
post
Delete item to checklist by id
delete
Update checklist for task
patch
Bulk ready tasks
post
Bulk deletion tasks
post
Bulk editing tasks
post
Transfer tasks to another user.
post
Transfer tasks to department.
post
Take on a task.
patch
Stopped the task.
patch
Complete the task
patch
Restart the task
patch
Watch the task.
patch
Unwatch the task.
patch
Get available settings list
get
Update tasks settings
put
filesService
Lists the file info
get
Upload one or more files
post
Lists the file info
get
Lists the file info
get
Update file by id
patch
Delete file by id
delete
Update files by entity
patch
Delete files by entity
delete
commentsService
Get comments list
get
Create a comment
post
Get comments list by array of entity ids
get
Update comment by id
patch
Delete comment by id
delete
Delete comments to entity
delete
groupService
Get groups list
get
Create group
post
Shows the group info
get
Update group. Only available to group owner.
patch
Delete group. Only available to group owner.
delete
Upload group logo. Only available to group owner or moderator.
post
Adding a user to a group.
patch
Remove user from group.
patch
Adding the current user to the group.
patch
Remove the current user from the group.
patch
Getting a list of invitations to groups of the current user.
get
Sending invitations to groups. Only available to group owner.
post
Refusal of an invitation. Only available to the current user.
delete
Transfer groups to another user.
post
Transfer groups to another user.
post
Transfer groups to another user.
post
Getting a list of invited users for particular private group
get
Add join request for private group
post
Check if user sent join request to the private group
get
Decline private group join request
delete
crmService
Get available entities list.
get
Create entity.
post
Get available field types list. Available only for all users.
get
Get available fields list.
get
Create field.
post
Get field by code. and users who have access to crm.
get
Edit field by code. and crm maker.
patch
Delete field by code.
delete
Get list elements. Available for all users.
get
Creating or editing list items.
post
Deleting a list item.
delete
Get available crm entity items list.
get
Create crm entity item.
post
Get available companies list.
get
Get available contacts list.
get
Get available deals list.
get
Get available leads list.
get
Get available leads fields list.
get
Get crm entity item. and users who have access to crm.
get
Edit crm entity item. and users who have access to crm.
patch
Delete crm entity item. Available only for admin users and users who have access to crm.
delete
Converting crm entity item. Available for all users.
post
Get available crm-task entity items list.
get
Create crm-task entity item.
post
Get crm-task entity item. and users who have access to crm.
get
Edit crm-task entity item. and users who have access to crm.
patch
Delete crm-task entity item. Available only for admin users and users who have access to crm.
delete
Get funnels.
get
Funnel creating.
post
Get funnels.
get
Funnel editing.
patch
Funnel deleting.
delete
Get kanban stages. Available for all users.
get
Create a kanban stage.
post
Get kanban stage. Available for all users.
get
Editing a Kanban Stage.
patch
Deleting a Kanban Stage.
delete
Move a kanban stage. Available only for all users.
post
Get funnels.
get
Funnel creating.
post
Funnel editing.
patch
Funnel deleting.
delete
Get call event data
get
/crm/v1/events/call
post
/crm/v1/events/call/{call_event_id}
patch
/crm/v1/events/call/{call_event_id}
delete
Get available crm entity items list.
get
Get all product categories in tree view.
get
Create product category.
post
/crm/v1/static/product-categories/{itemId}
get
/crm/v1/static/product-categories/{itemId}
patch
Delete product category by id
delete
Get measurement units list
get
Create measurement unit.
post
Get measurement unit by id
get
Update measurement unit by id
patch
Detete measurement unit by id
delete
Get taxes list
get
Create tax
post
Update tax by id
patch
Delete tax by id
delete
Get products list
get
Create product
post
Get product by id
get
Update product by id
patch
Delete product by id
delete
Get or create product list for entity.
get
Update entity product list by id
patch
Create new list product.
post
/crm/v1/static/list-products/{itemId}
get
/crm/v1/static/list-products/{itemId}
patch
/crm/v1/static/list-products/{itemId}
delete
Mass update list products.
patch
Mass delete list products.
delete
/crm/v1/documents/templates
get
/crm/v1/documents/templates
post
/crm/v1/documents/templates
patch
/crm/v1/documents/templates
delete
/crm/v1/documents/templates/fields
get
/crm/v1/documents/templates/fields/filter-entities
get
/crm/v1/documents
get
/crm/v1/documents
post
/crm/v1/documents/{document_id}
patch
/crm/v1/documents/{document_id}/fields
get
/crm/v1/documents/{document_id}/fields
patch
/crm/v1/requisites/regions
get
/crm/v1/requisites/templates
get
/crm/v1/requisites/templates
post
/crm/v1/requisites/templates/{requisite_id}
patch
/crm/v1/requisites/templates/{requisite_id}
delete
/crm/v1/requisites
get
/crm/v1/requisites
post
/crm/v1/requisites/{requisite_id}
get
/crm/v1/requisites/{requisite_id}
patch
/crm/v1/requisites/{requisite_id}
delete
/crm/v1/requisites/{requisite_id}/bank_requisites
get
/crm/v1/requisites/{requisite_id}/bank_requisites
post
/crm/v1/requisites/{requisite_id}/bank_requisites
delete
/crm/v1/requisites/{requisite_id}/bank_requisites/{bank_requisite_id}
patch
/crm/v1/requisites/{requisite_id}/bank_requisites/{bank_requisite_id}
delete
searchService
Search data from all services
get
fileImport
/fileimport/v1/csv-import
post
appService
Get applications list.
get
Create app
post
Update app data
patch
Delete app
delete
emailService
Retrieve Emails List
get
Retrieve Email by ID
get
Add Email Credentials
post
Update Email Credentials
patch
Add Email Settings
post
Update Email Settings
patch
Retrieve CRM integration settings for a specific email.
get
Update CRM integration settings for a specific email. Available only for mailbox owner or users with email role setter.
patch
Retrieve all email folders
get
Add a new folder to an email account
post
Delete an email folder
delete
Get Signatures List
get
Create a New Signature
post
Update a Signature
patch
Delete an email signature
delete
Retrieve Letters by Folder
get
Add Letter to Send Queue
post
Retrieve Letters by IDs
get
Delete Letters
delete
Update Letter CRM Entities
patch
Move Letters to Folder
patch
Mark Letters as Read
patch
Mark Letters as Unread
patch
history
Get history for a specific service and entity
get
activitiesService
Get activities list
get
Create activity
post
Show activity
get
Update activity
patch
Delete activity by id
delete
Bulk deletion activities
delete
Messenger service
chats
/messenger/v1/chats
get
/messenger/v1/chats
post
/messenger/v1/chats
patch
/messenger/v1/chats/findByMeta
get
/messenger/v1/chats/findAllByMeta
get
/messenger/v1/chats/{id}
get
/messenger/v1/chats/{id}
delete
/messenger/v1/chats/{id}/members
post
/messenger/v1/chats/{id}/members
delete
/messenger/v1/chats/{id}/leave
post
/messenger/v1/chats/{id}/setActiveValue
post
/messenger/v1/chats/{id}/pin
post
/messenger/v1/chats/{id}/unpin
post
/messenger/v1/chats/{id}/mute
post
/messenger/v1/chats/{id}/unmute
post
messages
/messenger/v1/messages
get
/messenger/v1/messages
post
/messenger/v1/messages
patch
/messenger/v1/messages/readMessages
post
/messenger/v1/messages/{id}/goToMessage
get
/messenger/v1/messages/forwardMessages
post
/messenger/v1/messages/getPinnedMessages
get
/messenger/v1/messages/{id}/pin
post
/messenger/v1/messages/{id}/unpin
post
/messenger/v1/messages/deleteMessages
delete
/messenger/v1/messages/readAll
post
/messenger/v1/messages/{id}
delete
/messenger/v1/messages/{id}
get
external-lines
/messenger/v1/external-lines
get
/messenger/v1/external-lines
post
/messenger/v1/external-lines/{id}
get
/messenger/v1/external-lines/{id}
delete
/messenger/v1/external-lines/{id}
patch
telephony
/messenger/v1/telephony/call/start
post
/messenger/v1/telephony/call/end
post
search
/messenger/v1/search/messages
get
/messenger/v1/search/{chatId}
get
Powered by
Update password
patch
https://{domain}.uspacy.ua/auth/v1/users/change_password
Update self password
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
domain
.uspacy.ua
/auth/v1/users/change_password
RESPONSE
Click
Try It!
to start a request and see the response here!