Client managers
Use these methods to get, update or delete information about the managers to which clients can be assigned.
GET[host]/api/v2/managers |
|
GET[host]/api/v2/managers/{managerId} |
|
POST[host]/api/v2/managers |
|
PATCH[host]/api/v2/managers/{managerId} |
|
DELETE[host]/api/v2/managers/{managerId} |
Get a list of managers
Use this method to obtain a list of the managers registered in the Back Office.
To obtain detailed information about a specific manager, use a separate method to get manager details.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
The following filter parameters are available for this method:
The manager email address.
- name
The manager name.
- isEnabled
If
true
, a manager profile is enabled; otherwise,false
.
Refer to the Query parameters section of the Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/managers
curl --location --request GET 'https://host.name/api/v2/managers?sort_order=desc&limit=10&offset=0&filter[email]=jsmith@example.com.com&filter[name]=Jane&filter[isEnabled]=1&sort_by=createTime' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'
Response
A response includes an array of Client Manager objects providing information about the managers matching the request parameters.
Get manager details
Use this method to obtain detailed information about a specified manager.
To obtain a list of the managers registered in the Back Office, use a separate method to get a managers list.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- managerId required
The manager identifier.
GET[host]/api/v2/managers/{managerId}
curl --location --request GET 'https://host.name/api/v2/managers/1' \
--header 'Authorization: Bearer <token>'
Response
A response includes a Client Manager object providing information about the specified manager.
Create a manager profile
Use this method to create a new manager profile.
Request
Header parameters:
Authorization: Bearer <token>
Body:
Specify the following parameters for a manager profile:
- email string required
The manager email address.
- name string
The manager name.
- phone string
The manager phone number.
- isEnabled integer
If
true
, a manager profile is enabled; otherwise,false
.- title string
The title used with a manager name (such as
Mr.
orMs.
).- resources array
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
POST[host]/api/v2/managers
curl --location --request POST 'https://host.name/api/v2/managers' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"email": "jsmith@example.com",
"name": "Jane Smith",
"phone": "+79992221111",
"isEnabled": 0,
"title": "Ms.",
"resources": [
{
"key": "caption",
"locale": "en_US",
"value": "value"
},
{
"key": "caption",
"locale": "ar_AE",
"value": "value"
}
]
}'
Response
A response includes a Client Manager object providing the information about the created manager profile.
Update a manager profile
Use this method to update manager profile data.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- managerId required
The manager identifier.
Body:
The following field values can be updated:
- email string
The manager email address.
- name string
The manager name.
- phone string
The manager phone number.
- isEnabled integer
If
true
, a manager profile is enabled; otherwise,false
.- title string
The title used with a manager name (such as
Mr.
orMs.
).- resources array
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
PUT[host]/api/v2/managers/{managerId}
curl --location --request PATCH 'https://host.name/api/v2/managers/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"email": "jsmith@example.com",
"name": "Jane Smith",
"phone": "+79992221111",
"isEnabled": 1,
"title": "Ms.",
"resources": [
{
"key": "caption",
"locale": "en_US",
"value": "value"
},
{
"key": "caption",
"locale": "ar_AE",
"value": "value"
}
]
}'
Response
A response includes a Client Manager object providing the information about the updated manager profile.
Remove a manager profile
Use this method to remove a specified manager profile.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- managerId required
The manager identifier.
DELETE[host]/api/v2/managers/{managerId}
curl --location --request DELETE 'https://host.name/api/v2/managers/1' \
--header 'Authorization: Bearer <token>'
Response
In case of success, no response body is returned.