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

Name	Description	Type	Additional information
id		string	None.

Body Parameters

TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionRequest

Name	Description	Type	Additional information
AccountsAddressBookGroupAccess		Collection of TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressBookGroupPermissionDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountsAddressBookGroupAccess": [
    {
      "ID": "b49e053f-8707-415b-948f-1fa5bab06740",
      "GroupID": "78a0bb04-7378-4639-a180-3d8b65f45d48",
      "PermissionLevel": 0
    },
    {
      "ID": "b49e053f-8707-415b-948f-1fa5bab06740",
      "GroupID": "78a0bb04-7378-4639-a180-3d8b65f45d48",
      "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>b49e053f-8707-415b-948f-1fa5bab06740</ID>
      <GroupID>78a0bb04-7378-4639-a180-3d8b65f45d48</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
    <AccountAddressBookGroupPermissionDetails>
      <ID>b49e053f-8707-415b-948f-1fa5bab06740</ID>
      <GroupID>78a0bb04-7378-4639-a180-3d8b65f45d48</GroupID>
      <PermissionLevel>NONE</PermissionLevel>
    </AccountAddressBookGroupPermissionDetails>
  </AccountsAddressBookGroupAccess>
</AccountAddressbookGroupPermissionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionRequest'.

Response Information

Resource Description

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

Name	Description	Type	Additional 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": "19c5ae19-a467-448e-9c21-fd0f8922a596",
        "Name": "sample string 2",
        "GroupID": "5a61dc19-c4f2-425c-9b35-e576ee2df2f5",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      },
      {
        "ID": "19c5ae19-a467-448e-9c21-fd0f8922a596",
        "Name": "sample string 2",
        "GroupID": "5a61dc19-c4f2-425c-9b35-e576ee2df2f5",
        "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>19c5ae19-a467-448e-9c21-fd0f8922a596</ID>
        <Name>sample string 2</Name>
        <GroupID>5a61dc19-c4f2-425c-9b35-e576ee2df2f5</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
      <AccountAddressbookGroupPermissionResponse>
        <ID>19c5ae19-a467-448e-9c21-fd0f8922a596</ID>
        <Name>sample string 2</Name>
        <GroupID>5a61dc19-c4f2-425c-9b35-e576ee2df2f5</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>