Custom title groups
Get all custom title groups
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Returns custom title groups configured for the chain. Use Get all custom titles to retrieve the titles within a group. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customTitleGroups/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CustomTitleGroupIds": [
"4b1f6f0e-9e9a-4d94-9f3d-6c9a2f1a0b6c",
"7a2e6d3c-3f8b-4b2a-8b6a-1e5c9d3a7f42"
],
"ActivityStates": [
"Active"
],
"ChainIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"5fcd1933-22f2-40b9-84da-7db04cbecec2"
],
"Limitation": {
"Count": 100
}
}ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of Chain. If not specified, the operation returns data for all chains within scope of the Access Token.
CustomTitleGroupIds
array of string
optional, max 100 items
Unique identifiers of CustomTitleGroup.
ActivityStates
array of Activity state
optional
Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
Cursor
string
optional
Unique identifier of the last custom title group returned. Use it as the Cursor in Limitation on a subsequent request to fetch the next batch.
Custom title group
Id
string
required
Unique identifier of the custom title group.
ChainId
string
required
Unique identifier of the Chain the custom title group belongs to.
Name
string
required, max length 255 characters
Name of the custom title group.
IsEditable
boolean
required
Whether the custom title group itself can be renamed or deleted. Groups managed by Mews are not editable. This governs the group only – the custom titles within it are always editable and can be managed regardless of this value.
IsActive
boolean
required
Whether the custom title group is active. Inactive groups can still be referenced by existing custom titles – request them with the ActivityStates filter.
Add custom title groups
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Adds custom title groups to the chain. A group is created without any custom titles; use Add custom titles to add them. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customTitleGroups/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
CustomTitleGroups
array of Custom title group add parameters
required, max 100 items
Custom title groups to be added.
Custom title group add parameters
Name
string
required, max length 255 characters
Name of the custom title group. The group is created without any custom titles; add them afterwards via Add custom titles.
Response
Update custom title groups
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Renames the specified custom title groups. Fails if any specified group has IsEditable set to false and its Name would actually change; a group whose Name is omitted, or resolves to its current value, is left as is regardless of IsEditable. Use Add custom titles, Update custom titles or Delete custom titles to manage the titles within a group. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customTitleGroups/update
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
CustomTitleGroupUpdates
array of Custom title group update parameters
required, max 100 items
Custom title groups to be updated.
Custom title group update parameters
CustomTitleGroupId
string
required
Unique identifier of the CustomTitleGroup to be updated.
Name
optional, max length 255 characters
Name of the custom title group (or null if the name should not be updated).
Response
Delete custom title groups
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Deletes custom title groups, along with the custom titles within them. Fails if any specified group has IsEditable set to false. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customTitleGroups/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
CustomTitleGroupIds
array of string
required, max 30 items
Unique identifiers of the CustomTitleGroup to be deleted.
Response
Last updated
Was this helpful?