PUT api/v2/admin/accounts/{id}/addressbookgrouppermissions

This method modifies addressbook group permissions for chosen sub accounts. You can only modify permissions for sub accounts that are one level below. Changing group permissions for sub that is one level below will automatically take care of all the subs that are below in the hierarchy.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The account ID

globally unique identifier

Required

Body Parameters

AccountAddressbookGroupPermissionV2Request
NameDescriptionTypeAdditional information
AccountsAddressBookGroupAccess

Collection of AccountAddressBookGroupPermissionDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountsAddressBookGroupAccess": [
    {
      "ID": "89f9ec55-1ae4-4242-af84-d26326dad348",
      "GroupID": "baa0c19c-68fd-4cf8-b591-24966a060147",
      "PermissionLevel": 0
    },
    {
      "ID": "89f9ec55-1ae4-4242-af84-d26326dad348",
      "GroupID": "baa0c19c-68fd-4cf8-b591-24966a060147",
      "PermissionLevel": 0
    }
  ]
}

application/xml, text/xml

Sample:
<AccountAddressbookGroupPermissionV2Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccountsAddressBookGroupAccess>
    <AccountAddressBookGroupPermissionDetails>
      <ID>89f9ec55-1ae4-4242-af84-d26326dad348</ID>
      <GroupID>baa0c19c-68fd-4cf8-b591-24966a060147</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
    <AccountAddressBookGroupPermissionDetails>
      <ID>89f9ec55-1ae4-4242-af84-d26326dad348</ID>
      <GroupID>baa0c19c-68fd-4cf8-b591-24966a060147</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
  </AccountsAddressBookGroupAccess>
  <UserPassword>sample string 1</UserPassword>
</AccountAddressbookGroupPermissionV2Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfAccountAddressbookGroupPermissionResponse[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAccountAddressbookGroupPermissionResponse[]

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "ID": "0d75bbc7-ff31-47ba-b6a7-1b9c28252b43",
        "Name": "sample string 2",
        "GroupID": "89bf09ee-478f-480d-bb9e-6ac63c43be14",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      },
      {
        "ID": "0d75bbc7-ff31-47ba-b6a7-1b9c28252b43",
        "Name": "sample string 2",
        "GroupID": "89bf09ee-478f-480d-bb9e-6ac63c43be14",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfAccountAddressbookGroupPermissionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <AccountAddressbookGroupPermissionResponse>
        <ID>0d75bbc7-ff31-47ba-b6a7-1b9c28252b43</ID>
        <Name>sample string 2</Name>
        <GroupID>89bf09ee-478f-480d-bb9e-6ac63c43be14</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
      <AccountAddressbookGroupPermissionResponse>
        <ID>0d75bbc7-ff31-47ba-b6a7-1b9c28252b43</ID>
        <Name>sample string 2</Name>
        <GroupID>89bf09ee-478f-480d-bb9e-6ac63c43be14</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>