EnterpriseBusinessManagementApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| activateEnterpriseUser | POST /enterprises/{enterprise_id}/users/{user_id}/activate | Activate an enterprise user |
| createEnterpriseDomain | POST /enterprises/{enterprise_id}/domains | Create enterprise domain |
| createEnterpriseRole | POST /enterprises/{enterprise_id}/roles | Create enterprise role |
| createEnterpriseWebhook | POST /enterprises/{enterprise_id}/webhooks | Create enterprise webhook |
| deleteEnterpriseDomain | DELETE /enterprises/{enterprise_id}/domains/{domain_id} | Delete enterprise domain |
| deleteEnterpriseRole | DELETE /enterprises/{enterprise_id}/roles/{role_id} | Delete enterprise role |
| deleteEnterpriseUser | DELETE /enterprises/{enterprise_id}/users/{user_id} | Delete an enterprise user |
| deleteEnterpriseWebhook | DELETE /enterprises/{enterprise_id}/webhooks/{webhook_id} | Delete enterprise webhook |
| getDomainVerificationStatus | GET /enterprises/{enterprise_id}/domains/{domain_id}/verification | Get domain verification status |
| getEnterpriseDomain | GET /enterprises/{enterprise_id}/domains/{domain_id} | Get domain by ID |
| getEnterpriseRole | GET /enterprises/{enterprise_id}/roles/{role_id} | Get role by ID |
| getEnterpriseUser | GET /enterprises/{enterprise_id}/users/{user_id} | Get a specific enterprise user by ID |
| getEnterpriseWebhook | GET /enterprises/{enterprise_id}/webhooks/{webhook_id} | Get webhook by ID |
| listEnterpriseDomains | GET /enterprises/{enterprise_id}/domains | List enterprise domains |
| listEnterpriseRoles | GET /enterprises/{enterprise_id}/roles | List enterprise roles |
| listEnterpriseUsers | GET /enterprises/{enterprise_id}/users | List all users in an enterprise |
| listEnterpriseWebhooks | GET /enterprises/{enterprise_id}/webhooks | List enterprise webhooks |
| resetEnterpriseUserPassword | POST /enterprises/{enterprise_id}/users/{user_id}/reset-password | Reset an enterprise user’s password |
| suspendEnterpriseUser | POST /enterprises/{enterprise_id}/users/{user_id}/suspend | Suspend an enterprise user |
| testEnterpriseWebhook | POST /enterprises/{enterprise_id}/webhooks/{webhook_id}/test | Test webhook endpoint |
| updateEnterpriseDomain | PUT /enterprises/{enterprise_id}/domains/{domain_id} | Update enterprise domain |
| updateEnterpriseRole | PUT /enterprises/{enterprise_id}/roles/{role_id} | Update enterprise role |
| updateEnterpriseUser | PUT /enterprises/{enterprise_id}/users/{user_id} | Update an enterprise user’s information |
| updateEnterpriseWebhook | PUT /enterprises/{enterprise_id}/webhooks/{webhook_id} | Update enterprise webhook |
| verifyEnterpriseDomain | POST /enterprises/{enterprise_id}/domains/{domain_id}/verify | Verify domain ownership |
activateEnterpriseUser
EnterpriseUserResponse activateEnterpriseUser(enterprise_id, user_id)
Activate an enterprise user
Reactivates a previously suspended user, restoring their access to the enterprise.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user to activate | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
createEnterpriseDomain
EnterpriseDomainResponse createEnterpriseDomain(enterprise_id, AddEnterpriseDomainRequest)
Create enterprise domain
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| AddEnterpriseDomainRequest | AddEnterpriseDomainRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createEnterpriseRole
EnterpriseRoleResponse createEnterpriseRole(enterprise_id, CreateEnterpriseRoleRequest)
Create enterprise role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| CreateEnterpriseRoleRequest | CreateEnterpriseRoleRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createEnterpriseWebhook
EnterpriseWebhookResponse createEnterpriseWebhook(enterprise_id, CreateEnterpriseWebhookRequest)
Create enterprise webhook
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| CreateEnterpriseWebhookRequest | CreateEnterpriseWebhookRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteEnterpriseDomain
DeleteResponse deleteEnterpriseDomain(enterprise_id, domain_id)
Delete enterprise domain
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| domain_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
deleteEnterpriseRole
DeleteResponse deleteEnterpriseRole(enterprise_id, role_id)
Delete enterprise role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
deleteEnterpriseUser
DeleteResponse deleteEnterpriseUser(enterprise_id, user_id)
Delete an enterprise user
Permanently removes a user from the enterprise. This action cannot be undone.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
deleteEnterpriseWebhook
DeleteResponse deleteEnterpriseWebhook(enterprise_id, webhook_id)
Delete enterprise webhook
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getDomainVerificationStatus
DomainVerificationStatusResponse getDomainVerificationStatus(enterprise_id, domain_id)
Get domain verification status
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| domain_id | Long | [default to null] |
Return type
DomainVerificationStatusResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getEnterpriseDomain
EnterpriseDomainResponse getEnterpriseDomain(enterprise_id, domain_id)
Get domain by ID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| domain_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getEnterpriseRole
EnterpriseRoleResponse getEnterpriseRole(enterprise_id, role_id)
Get role by ID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getEnterpriseUser
EnterpriseUserResponse getEnterpriseUser(enterprise_id, user_id)
Get a specific enterprise user by ID
Retrieves detailed information about a single user within an enterprise.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getEnterpriseWebhook
EnterpriseWebhookResponse getEnterpriseWebhook(enterprise_id, webhook_id)
Get webhook by ID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listEnterpriseDomains
PaginatedResponse_EnterpriseDomainResponse listEnterpriseDomains(enterprise_id, page, per_page, verified)
List enterprise domains
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| page | Long | [optional] [default to null] | |
| per_page | Long | [optional] [default to null] | |
| verified | Boolean | [optional] [default to null] |
Return type
PaginatedResponse_EnterpriseDomainResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listEnterpriseRoles
PaginatedResponse_EnterpriseRoleResponse listEnterpriseRoles(enterprise_id, page, per_page, search)
List enterprise roles
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| page | Long | [optional] [default to null] | |
| per_page | Long | [optional] [default to null] | |
| search | String | [optional] [default to null] |
Return type
PaginatedResponse_EnterpriseRoleResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listEnterpriseUsers
PaginatedResponse_EnterpriseUserResponse listEnterpriseUsers(enterprise_id, page, per_page, search, status, role_id)
List all users in an enterprise
Returns a paginated list of users belonging to the specified enterprise. Supports filtering by search query, status, and role.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Number of items per page (default: 20) | [optional] [default to null] |
| search | String | Optional search query to filter users by name or email | [optional] [default to null] |
| status | String | Optional status filter (active, suspended, etc.) | [optional] [default to null] |
| role_id | Long | Optional role ID to filter users by role | [optional] [default to null] |
Return type
PaginatedResponse_EnterpriseUserResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listEnterpriseWebhooks
PaginatedResponse_EnterpriseWebhookResponse listEnterpriseWebhooks(enterprise_id, page, per_page)
List enterprise webhooks
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_EnterpriseWebhookResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
resetEnterpriseUserPassword
PasswordResetResponse resetEnterpriseUserPassword(enterprise_id, user_id)
Reset an enterprise user’s password
Generates and assigns a new temporary password for the user. The temporary password is returned in the response and should be securely communicated to the user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user whose password should be reset | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
suspendEnterpriseUser
EnterpriseUserResponse suspendEnterpriseUser(enterprise_id, user_id)
Suspend an enterprise user
Temporarily suspends a user’s access to the enterprise. The user can be reactivated later.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user to suspend | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
testEnterpriseWebhook
WebhookTestResponse testEnterpriseWebhook(enterprise_id, webhook_id)
Test webhook endpoint
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateEnterpriseDomain
EnterpriseDomainResponse updateEnterpriseDomain(enterprise_id, domain_id, UpdateEnterpriseDomainRequest)
Update enterprise domain
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| domain_id | Long | [default to null] | |
| UpdateEnterpriseDomainRequest | UpdateEnterpriseDomainRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateEnterpriseRole
EnterpriseRoleResponse updateEnterpriseRole(enterprise_id, role_id, UpdateEnterpriseRoleRequest)
Update enterprise role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| role_id | Long | [default to null] | |
| UpdateEnterpriseRoleRequest | UpdateEnterpriseRoleRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateEnterpriseUser
EnterpriseUserResponse updateEnterpriseUser(enterprise_id, user_id, UpdateEnterpriseUserRequest)
Update an enterprise user’s information
Updates the profile and settings of an existing user within the enterprise. Only the fields provided in the request body will be updated.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | The ID of the enterprise | [default to null] |
| user_id | Long | The ID of the user to update | [default to null] |
| UpdateEnterpriseUserRequest | UpdateEnterpriseUserRequest | The update request containing the fields to modify |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateEnterpriseWebhook
EnterpriseWebhookResponse updateEnterpriseWebhook(enterprise_id, webhook_id, UpdateEnterpriseWebhookRequest)
Update enterprise webhook
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| webhook_id | Long | [default to null] | |
| UpdateEnterpriseWebhookRequest | UpdateEnterpriseWebhookRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
verifyEnterpriseDomain
DomainVerifyResponse verifyEnterpriseDomain(enterprise_id, domain_id)
Verify domain ownership
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enterprise_id | Long | [default to null] | |
| domain_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8