DELETE api/v1/addressbook/groups/{groupID}

The method removes the group from the account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupID

The id of the group that will be deleted or disabled.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Status of the request.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.AddressBooks.Group
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.AddressBooks.Group

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": {
      "GroupName": "sample string 1",
      "GroupID": "5aecbdd4-7a06-4d9f-8fae-b510c5d465ef"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfGroup 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>
      <GroupName>sample string 1</GroupName>
      <GroupID>5aecbdd4-7a06-4d9f-8fae-b510c5d465ef</GroupID>
    </Detail>
  </ResponseData>
</ResponseOfGroup>