Jump to

• Request
• Response
• Examples

Update an account group

patch

/services/rest/connect/v1.4/accountGroups/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the account group.

Body ()

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.

{
    "description":"The Account Groups allow staff accounts to be grouped for better organization.",
    "type":"object",
    "properties":{
        "updatedTime":{
            "description":"The date and time when the account group was last updated. This attribute is read-only.",
            "type":"string"
        },
        "name":{
            "description":"The name of the account group in the language of the current interface. This attribute is read-only.",
            "maxLength":80,
            "type":"string"
        },
        "lookupName":{
            "description":"The name used to look up the account group.",
            "maxLength":255,
            "type":"string"
        },
        "descriptions":{
            "description":"The list of descriptions, one for each supported language.",
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "$ref":"#/definitions/accountGroups-descriptions"
        },
        "createdTime":{
            "description":"The date and time when the account group was created. This attribute is read-only.",
            "type":"string"
        },
        "attributes":{
            "description":"The Account Group attributes.",
            "type":"object",
            "$ref":"#/definitions/accountGroups-attributes"
        },
        "id":{
            "description":"The unique identifier of the account group.",
            "minimum":1,
            "type":"integer",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "description":"The order in which this account group is displayed relative to other members of the same group.",
            "minimum":1,
            "type":"integer",
            "maximum":2147483647
        },
        "names":{
            "description":"The list of names, one for each supported language.",
            "items":{
                "type":"object"
            },
            "type":"array",
            "$ref":"#/definitions/accountGroups-names"
        }
    }
}

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.

{
    "description":"The group of flags that can be associated with account group.",
    "type":"object",
    "properties":{
        "customerCareAccess":{
            "description":"The customer care access group.",
            "type":"boolean"
        }
    }
}

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.

{
    "description":"The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.",
    "type":"object",
    "properties":{
        "language":{
            "description":"The ID of the language. This is the key for the list entry.",
            "type":"object",
            "$ref":"#/definitions/namedIDs-accountGroups-descriptions-language"
        },
        "labelText":{
            "description":"The label text.",
            "maxLength":1333,
            "type":[
                "string",
                "null"
            ]
        }
    }
}

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.

{
    "description":"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.",
    "type":"object",
    "properties":{
        "language":{
            "description":"The ID of the language. This is the key for the list entry.",
            "type":"object",
            "$ref":"#/definitions/namedIDs-accountGroups-names-language"
        },
        "labelText":{
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80,
            "type":"string"
        }
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID value",
            "minimum":0,
            "type":"integer"
        },
        "lookupName":{
            "description":"The name used to lookup this object",
            "maxLength":255,
            "type":"string"
        }
    }
}

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

{
    "description":"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.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID value",
            "minimum":0,
            "type":"integer"
        },
        "lookupName":{
            "description":"The name used to lookup this object",
            "maxLength":255,
            "type":"string"
        }
    }
}

Back to Top

Response

Default Response

Back to Top

Examples

Use the PATCH operation with the following syntax to partially update an account group object:

https://your_site_interface/services/rest/connect/version/accountGroups/accountGroup_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133

Request body example

{ "names": [{"labelText":"NewAccountGroupLogin", "language":{"id":1}}] }

Response example

The status 200 OK is returned. Then getting the data for account group 100133 returns the following:

{
    "id": 100133,
    "lookupName": "NewAccountGroupLogin",
    "attributes": {
        "customerCareAccess": false
    },
    "descriptions": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/descriptions"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/descriptions/{description_id}",
                "templated": true
            }
        ]
    },
    "displayOrder": 2,
    "name": "NewAccountGroupLogin",
    "names": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/names"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133/names/{name_id}",
                "templated": true
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accountGroups/100133"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accountGroups",
            "mediaType": "application/schema+json"
        }
    ]
}

Note:

The value of lookupName for account group 100133 used to be NewAccountGroupName1, and is now NewAccountGroupLogin.

Back to Top