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.AccountAddressbookGroupPermissionRequestName | Description | Type | Additional information |
---|---|---|---|
AccountsAddressBookGroupAccess | Collection of TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressBookGroupPermissionDetails |
None. |
Request Formats
application/json, text/json
Sample:
{ "AccountsAddressBookGroupAccess": [ { "ID": "a2451ceb-a5a7-43f3-86fb-2107dc1c5ebc", "GroupID": "ee7823d9-7b2f-4341-bafe-f2167f4b2d07", "PermissionLevel": 0 }, { "ID": "a2451ceb-a5a7-43f3-86fb-2107dc1c5ebc", "GroupID": "ee7823d9-7b2f-4341-bafe-f2167f4b2d07", "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>a2451ceb-a5a7-43f3-86fb-2107dc1c5ebc</ID> <GroupID>ee7823d9-7b2f-4341-bafe-f2167f4b2d07</GroupID> <PermissionLevel>NONE</PermissionLevel> </AccountAddressBookGroupPermissionDetails> <AccountAddressBookGroupPermissionDetails> <ID>a2451ceb-a5a7-43f3-86fb-2107dc1c5ebc</ID> <GroupID>ee7823d9-7b2f-4341-bafe-f2167f4b2d07</GroupID> <PermissionLevel>NONE</PermissionLevel> </AccountAddressBookGroupPermissionDetails> </AccountsAddressBookGroupAccess> </AccountAddressbookGroupPermissionRequest>
application/x-www-form-urlencoded
Sample:
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": "e5f23578-521a-40d5-9994-c8cb89615636", "Name": "sample string 2", "GroupID": "aaa6d3f0-f632-443c-b0f9-7a947cda5e0a", "GroupName": "sample string 4", "PermissionLevel": 0 }, { "ID": "e5f23578-521a-40d5-9994-c8cb89615636", "Name": "sample string 2", "GroupID": "aaa6d3f0-f632-443c-b0f9-7a947cda5e0a", "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>e5f23578-521a-40d5-9994-c8cb89615636</ID> <Name>sample string 2</Name> <GroupID>aaa6d3f0-f632-443c-b0f9-7a947cda5e0a</GroupID> <GroupName>sample string 4</GroupName> <PermissionLevel>NONE</PermissionLevel> </AccountAddressbookGroupPermissionResponse> <AccountAddressbookGroupPermissionResponse> <ID>e5f23578-521a-40d5-9994-c8cb89615636</ID> <Name>sample string 2</Name> <GroupID>aaa6d3f0-f632-443c-b0f9-7a947cda5e0a</GroupID> <GroupName>sample string 4</GroupName> <PermissionLevel>NONE</PermissionLevel> </AccountAddressbookGroupPermissionResponse> </Detail> </ResponseData> </ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>