PUT api/v1/admin/accounts/addressbookpermissions

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

Request Information

URI Parameters

None.

Body Parameters

A list of sub accountIDs along with

TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookPermissionRequest
NameDescriptionTypeAdditional information
accountsAddressbookAccess

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

None.

Request Formats

application/json, text/json

Sample:
{
  "accountsAddressbookAccess": [
    {
      "ID": "58e407c7-35f3-454c-bdb6-a9cb152e27a6",
      "PermissionLevel": 0
    },
    {
      "ID": "58e407c7-35f3-454c-bdb6-a9cb152e27a6",
      "PermissionLevel": 0
    }
  ]
}

application/xml, text/xml

Sample:
<AccountAddressbookPermissionRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <accountsAddressbookAccess>
    <AccountAddressBbookPermissionDetails>
      <ID>58e407c7-35f3-454c-bdb6-a9cb152e27a6</ID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBbookPermissionDetails>
    <AccountAddressBbookPermissionDetails>
      <ID>58e407c7-35f3-454c-bdb6-a9cb152e27a6</ID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBbookPermissionDetails>
  </accountsAddressbookAccess>
</AccountAddressbookPermissionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

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

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": "338aabd9-dbaa-4e6e-863d-068cafc0a36a",
        "Emailaddress": "sample string 2",
        "PermissionLevel": 0
      },
      {
        "ID": "338aabd9-dbaa-4e6e-863d-068cafc0a36a",
        "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>338aabd9-dbaa-4e6e-863d-068cafc0a36a</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
      <AccountAddressBookPermissionResponse>
        <ID>338aabd9-dbaa-4e6e-863d-068cafc0a36a</ID>
        <Emailaddress>sample string 2</Emailaddress>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressBookPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressBookPermissionResponse>