PUT api/v1/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

string

None.

Body Parameters

TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionRequest
NameDescriptionTypeAdditional information
AccountsAddressBookGroupAccess

Collection of TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressBookGroupPermissionDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountsAddressBookGroupAccess": [
    {
      "ID": "4a58eb11-d6c3-4f45-a6e7-e03fab8383c9",
      "GroupID": "227d5974-3ff7-4a52-aeee-d7399441e345",
      "PermissionLevel": 0
    },
    {
      "ID": "4a58eb11-d6c3-4f45-a6e7-e03fab8383c9",
      "GroupID": "227d5974-3ff7-4a52-aeee-d7399441e345",
      "PermissionLevel": 0
    }
  ]
}

application/xml, text/xml

Sample:
<AccountAddressbookGroupPermissionRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccountsAddressBookGroupAccess>
    <AccountAddressBookGroupPermissionDetails>
      <ID>4a58eb11-d6c3-4f45-a6e7-e03fab8383c9</ID>
      <GroupID>227d5974-3ff7-4a52-aeee-d7399441e345</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
    <AccountAddressBookGroupPermissionDetails>
      <ID>4a58eb11-d6c3-4f45-a6e7-e03fab8383c9</ID>
      <GroupID>227d5974-3ff7-4a52-aeee-d7399441e345</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
  </AccountsAddressBookGroupAccess>
</AccountAddressbookGroupPermissionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionResponse[]
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionResponse[]

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": "081b15fd-efbb-4fba-b8e3-3ec64069e156",
        "Name": "sample string 2",
        "GroupID": "2ac3c051-7622-4f68-972b-ad1b9c93a388",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      },
      {
        "ID": "081b15fd-efbb-4fba-b8e3-3ec64069e156",
        "Name": "sample string 2",
        "GroupID": "2ac3c051-7622-4f68-972b-ad1b9c93a388",
        "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>081b15fd-efbb-4fba-b8e3-3ec64069e156</ID>
        <Name>sample string 2</Name>
        <GroupID>2ac3c051-7622-4f68-972b-ad1b9c93a388</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
      <AccountAddressbookGroupPermissionResponse>
        <ID>081b15fd-efbb-4fba-b8e3-3ec64069e156</ID>
        <Name>sample string 2</Name>
        <GroupID>2ac3c051-7622-4f68-972b-ad1b9c93a388</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>