Client types
Use these methods to manage client types in the Back Office.
GET[host]/api/v2/clients/types |
|
GET[host]/api/v2/clients/types/{typeId} |
|
POST[host]/api/v2/clients/types |
|
PUT[host]/api/v2/clients/types/{typeId} PATCH[host]/api/v2/clients/types/{typeId} |
|
DELETE[host]/api/v2/clients/types/{typeId} |
Get a list of client types
Use this method to obtain a list of the available client types.
To obtain detailed information about a specific client type, use a separate method to get client type details.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
The following sorting parameter is available for this method:
- createTime
The date and time when a client type was created.
The following filter parameters are available for this method:
- enabled
If
true
, a client type can be assigned to clients; otherwise,false
.- group
The group to which a client is assigned. Possible values:
individual
— indicates an individual clientcorporative
— indicates a corporate client
- name
The client type name.
Refer to the Query parameters section of the Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/clients/types
curl --location -g --request GET 'https://host.name/api/v2/clients/types?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[enabled]=true&filter[group]=individual&filter[name]=Individual' \
--header 'Authorization: Bearer <token>'
Response
A response includes an array of Client Type objects providing information about the client types matching the request parameters.
Get client type details
Use this method to obtain detailed information about a specified client type.
To obtain a list of available client types created in the Back Office, use a separate method to get a list of client types.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- typeId required
The client type identifier.
GET[host]/api/v2/clients/types/{typeId}
curl --location --request GET 'https://host.name/api/v2/clients/types/1' \
--header 'Authorization: Bearer <token>'
Response
A response includes a Client Type object providing information about the specified client type.
Create a client type
Use this method to define a new client type.
Request
Header parameters:
Authorization: Bearer <token>
Body:
Specify the following parameters for a client type:
- enabled boolean required
If
true
, this type can be assigned to clients; otherwise,false
.- default boolean required
If
true
, this is the default type assigned to all newly registered clients; otherwise,false
.- name string required
The client type name.
- group string required
The group to which a client is assigned. Possible values:
individual
— indicates an individual clientcorporative
— indicates a corporate client
- wizard boolean required
If
true
, wizard pages are displayed to clients with the assigned type.
POST[host]/api/v2/clients/types
curl --location --request POST 'https://host.name/api/v2/clients/types' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"enabled": true,
"default": true,
"name": "Individual",
"group": "individual",
"wizard": true
}'
Response
A response includes a Client Type object providing information about the created client type.
Update a client type
Use this method to update a specified client type.
Note
Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- typeId required
The client type identifier.
Body:
The following field values can be updated for a specified client type:
- enabled boolean required
If
true
, this type can be assigned to clients; otherwise,false
.- default boolean required
If
true
, this is the default type assigned to all newly registered clients; otherwise,false
.- name string required
The client type name.
- group string required
The group to which a client is assigned. Possible values:
individual
— indicates an individual clientcorporative
— indicates a corporate client
- wizard boolean required
If
true
, wizard pages are displayed to clients with the assigned type.
PUT[host]/api/v2/clients/types/{typeId}
curl --location --request PUT 'https://host.name/api/v2/clients/types/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"enabled": true,
"default": true,
"name": "Individual",
"group": "individual",
"wizard": true
}'
Response
A response includes a Client Type object providing information about the updated client type.
Delete a client type
Use this method to remove a specified client type.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- typeId required
The client type identifier.
DELETE[host]/api/v2/clients/types/{typeId}
curl --location --request DELETE 'https://host.name/api/v2/clients/types/1' \
--header 'Authorization: Bearer <token>'
Response
In case of success, no response body is returned.