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

This method modifies sub account access to the master account addressbook. The access either be given or taken away.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

A list of sub accountIDs along with

AccountAddressbookPermissionV2Request
NameDescriptionTypeAdditional information
accountsAddressbookAccess

Collection of AccountAddressBookPermissionDetail

None.

Request Formats

application/json, text/json

Sample:
{
  "accountsAddressbookAccess": [
    {
      "ID": "cb7b3727-153b-4e43-b32f-6b162cfe61fc",
      "PermissionLevel": 0
    },
    {
      "ID": "cb7b3727-153b-4e43-b32f-6b162cfe61fc",
      "PermissionLevel": 0
    }
  ]
}

application/xml, text/xml

Sample:
<AccountAddressbookPermissionV2Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <accountsAddressbookAccess>
    <AccountAddressBookPermissionDetail>
      <ID>cb7b3727-153b-4e43-b32f-6b162cfe61fc</ID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookPermissionDetail>
    <AccountAddressBookPermissionDetail>
      <ID>cb7b3727-153b-4e43-b32f-6b162cfe61fc</ID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookPermissionDetail>
  </accountsAddressbookAccess>
  <UserPassword>sample string 1</UserPassword>
</AccountAddressbookPermissionV2Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfAccountAddressBookPermissionResponse[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAccountAddressBookPermissionResponse[]

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": "11b885c5-e3b0-4175-9904-146a4e2d0208",
        "Emailaddress": "sample string 2",
        "PermissionLevel": 0
      },
      {
        "ID": "11b885c5-e3b0-4175-9904-146a4e2d0208",
        "Emailaddress": "sample string 2",
        "PermissionLevel": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfAccountAddressBookPermissionResponse 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>
      <AccountAddressBookPermissionResponse>
        <ID>11b885c5-e3b0-4175-9904-146a4e2d0208</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
      <AccountAddressBookPermissionResponse>
        <ID>11b885c5-e3b0-4175-9904-146a4e2d0208</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressBookPermissionResponse>