Create manager
The Create manager method is used for creating a manager for the current reseller or any of its downstream resellers.
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
POST {base_url}/api/v3/resellers/{reseller_id}/managers
Arguments
Name | Parameter Type | Data type | Required/ Optional | Description | |||||
---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating manager's information) | |||||
Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json | |||||
Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json | |||||
base_url | path | string | Required | ActivePlatform URL | |||||
reseller_id | path | integer | Required | ID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information) | |||||
data | form | object | Required | Information about the attributes of the operation | |||||
attributes | form | object | Required | Attributes of the operation | |||||
name | form | string | Required | Manager's name | |||||
form | string | Required | Manager's email which will be used as a login to the Operator Control Panel | ||||||
admin | form | bool | Optional | The administrator indicator:
| |||||
manager_role_id | form | integer | Optional | The manager role ID (see Managers' roles and Get list of roles). Ignored if | |||||
password | form | string | Required | Manager's password which will be used for signing in to the Operator Control Panel. The password requirements see in Password settings | |||||
phone | form | string | Optional | Manager's phone number:
| |||||
manager_key | form | string | Optional | Unique manager's key This key allows linking an account to a manager (see Viewing and updating account's details) automatically when a customer orders a new service via Customer Store with a special URL parameter (see Buy-link template for ordering a service via Storefront). The key can include uppercase and lowercase characters, numbers, underscore, dot, and dash. The key is case-sensitive, so it is important to specify it in a buy-link exactly as on the manager information page. For example, carter81 and Carter81 are different keys, and they will not work together for the same manager. | |||||
custom_attributes | form | object | Optional | Manager's attributes (see Managing attributes) | |||||
data | form | array | Optional | Information about a manager's attribute | |||||
key | form | string | Depends on the attribute | Manager's attribute key | |||||
value | form | string | Depends on the attribute | Manager's attribute value. Depending on the value type, the value is specified in the following formats:
|
Response model
If no errors are encountered, the method returns data as the information about the created manager (see Get manager).
All validation errors for the manager attributes are displayed similar to the Operator Control Panel (see Adding a manager in ActivePlatform. Operator Control Panel).
Request example
POST /api/v3/resellers/1/managers
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
"data": {
"attributes": {
"name": "Angelica Johnson",
"email": "nigel65@example.org",
"admin": true,
"password": "qwerty",
"phone": "+375290000000",
"custom_attributes": {
"data": [
{
"key": "test",
"value": "1"
}
]
}
}
}
}
Response example
{
"data": {
"id": "317",
"type": "managers",
"attributes": {
"created_at": "2020-12-09T08:17:47.773+03:00",
"updated_at": "2020-12-09T08:17:47.776+03:00",
"reseller_id": 1,
"name": "Angelica Johnson",
"status": "active",
"email": "nigel65@example.org",
"manager_role": {
"id": null,
"name": null
},
"phone": "+375290000000",
"photo": null,
"manager_key": "",
"mfa_required": true,
"custom_attributes": {
"test": "1"
}
}
}
}