DELETE api/v3/addressbook/contacts

The method removes multiple Contacts from the account. If the all flag is set, removes all contacts from the contact except for the contacts provided in the list.

Request Information

URI Parameters

None.

Body Parameters

The contact IDs of the records to be deleted / disabled

TwoSms.CustomerPortalRole.API.AddressBooks.DeleteContactRequest

Name	Description	Type	Additional information
All	Set this to true if all contacts are to be removed from the address book.	boolean	None.
Contacts	List of all person numbers to be removed. If all is set to true, then this list contains all the person numbers that will be left in the address book after the call has executed.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "All": true,
  "Contacts": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<DeleteContactRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <All>true</All>
  <Contacts>
    <int>1</int>
    <int>2</int>
  </Contacts>
</DeleteContactRequest>

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.AddressBooks.DeleteContactRequest'.

Response Information

Resource Description

Status message of the request.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Object

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Object	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": {}
  }
}

application/xml, text/xml

Sample:

<ResponseOfObject 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 />
  </ResponseData>
</ResponseOfObject>