Create an account group
post
/services/rest/connect/v1.4/accountGroups
Request
The Account Groups allow staff accounts to be grouped for better organization.
Root Schema : accountGroups
Type:
object
The Account Groups allow staff accounts to be grouped for better organization.
Show Source
-
attributes(optional):
object accountGroups-attributes
The group of flags that can be associated with account group.
-
createdTime(optional):
string
The date and time when the account group was created. This attribute is read-only.
-
descriptions(optional):
object accountGroups-descriptions
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
-
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The order in which this account group is displayed relative to other members of the same group. -
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the account group. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the account group. -
name(optional):
string
Maximum Length:
80
The name of the account group in the language of the current interface. This attribute is read-only. -
names(optional):
object accountGroups-names
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
-
updatedTime(optional):
string
The date and time when the account group was last updated. This attribute is read-only.
Nested Schema : accountGroups-attributes
Type:
object
The group of flags that can be associated with account group.
Show Source
-
customerCareAccess(optional):
boolean
The customer care access group.
Nested Schema : accountGroups-descriptions
Type:
object
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
Show Source
-
labelText(optional):
[
"string",
"null"
]
Maximum Length:
1333
The label text. -
language(optional):
object namedIDs-accountGroups-descriptions-language
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : accountGroups-names
Type:
object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
-
labelText(optional):
string
Maximum Length:
80
The language-specific label text. The value cannot be null or empty. -
language(optional):
object namedIDs-accountGroups-names-language
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : namedIDs-accountGroups-descriptions-language
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
The ID value -
lookupName(optional):
string
Maximum Length:
255
The name used to lookup this object
Nested Schema : namedIDs-accountGroups-names-language
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
The ID value -
lookupName(optional):
string
Maximum Length:
255
The name used to lookup this object
Response
Default Response
Root Schema : accountGroups
Type:
object
The Account Groups allow staff accounts to be grouped for better organization.
Show Source
-
attributes(optional):
object accountGroups-attributes
The group of flags that can be associated with account group.
-
createdTime(optional):
string
The date and time when the account group was created. This attribute is read-only.
-
descriptions(optional):
object accountGroups-descriptions
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
-
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The order in which this account group is displayed relative to other members of the same group. -
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the account group. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the account group. -
name(optional):
string
Maximum Length:
80
The name of the account group in the language of the current interface. This attribute is read-only. -
names(optional):
object accountGroups-names
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
-
updatedTime(optional):
string
The date and time when the account group was last updated. This attribute is read-only.
Nested Schema : accountGroups-attributes
Type:
object
The group of flags that can be associated with account group.
Show Source
-
customerCareAccess(optional):
boolean
The customer care access group.
Nested Schema : accountGroups-descriptions
Type:
object
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
Show Source
-
labelText(optional):
[
"string",
"null"
]
Maximum Length:
1333
The label text. -
language(optional):
object namedIDs-accountGroups-descriptions-language
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : accountGroups-names
Type:
object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
-
labelText(optional):
string
Maximum Length:
80
The language-specific label text. The value cannot be null or empty. -
language(optional):
object namedIDs-accountGroups-names-language
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : namedIDs-accountGroups-descriptions-language
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
The ID value -
lookupName(optional):
string
Maximum Length:
255
The name used to lookup this object
Nested Schema : namedIDs-accountGroups-names-language
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
The ID value -
lookupName(optional):
string
Maximum Length:
255
The name used to lookup this object
Examples
Use POST with the following syntax to create a new account group object:
https://your_site_interface/services/rest/connect/version/accountGroups
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/accountGroups
Request body example
{
"names": [
{
"labelText": "NewAccountGroupName1",
"language": {
"id": 1
}
}
],
"displayOrder": 2
}
Note:
Thenames
field is required for account group.
Response example
{
"id": 100131,
"lookupName": "NewAccountGroupName1",
"attributes": {
"customerCareAccess": false
},
"descriptions": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131/descriptions"
},
{
"rel": "full",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131/descriptions/{description_id}",
"templated": true
}
]
},
"displayOrder": 2,
"name": "NewAccountGroupName1",
"names": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131/names"
},
{
"rel": "full",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131/names/{name_id}",
"templated": true
}
]
},
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100131"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accountGroups",
"mediaType": "application/schema+json"
}
]
}