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

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

A list of sub accountIDs along with

AccountAddressbookPermissionV2Request

Name	Description	Type	Additional information
accountsAddressbookAccess		Collection of AccountAddressBookPermissionDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "accountsAddressbookAccess": [
    {
      "ID": "b9a38911-e737-40cf-9c1b-8deaf4a0ad90",
      "PermissionLevel": 0
    },
    {
      "ID": "b9a38911-e737-40cf-9c1b-8deaf4a0ad90",
      "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>b9a38911-e737-40cf-9c1b-8deaf4a0ad90</ID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookPermissionDetail>
    <AccountAddressBookPermissionDetail>
      <ID>b9a38911-e737-40cf-9c1b-8deaf4a0ad90</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[]

Name	Description	Type	Additional 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": "1d637677-cc05-42c0-bb77-d0f4837c5960",
        "Emailaddress": "sample string 2",
        "PermissionLevel": 0
      },
      {
        "ID": "1d637677-cc05-42c0-bb77-d0f4837c5960",
        "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>1d637677-cc05-42c0-bb77-d0f4837c5960</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
      <AccountAddressBookPermissionResponse>
        <ID>1d637677-cc05-42c0-bb77-d0f4837c5960</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressBookPermissionResponse>