delete

Deletes virtual business cards.

  1. Restrictions
  2. Request
  3. Response
  4. Examples

Restrictions

Maximum of 1000 vCards per method call.

If a vCard is associated with an ad, it can't be deleted.

Request

Request structure in JSON format:

{
  "method": "delete",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    } /* required */
  }
}
Parameter Type Description Required
Params structure (for JSON) / DeleteRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting vCards to delete. Yes
IdsCriteria structure
Ids array of long

IDs of vCards to delete (maximum of 1000).

Yes

Response

Response structure in JSON format:

{
  "result": {  /* result */
    "DeleteResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ] 
    }, ... ] /* required */
  }
}
Parameter Type Description
Result structure (for JSON) / DeleteResponse structure (for SOAP)
DeleteResults array of ActionResult Results of deleting vCards.
ActionResult structure
Id long

ID of the deleted vCard. Returned if there aren't any errors. See the section Operations on object arrays.

Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.

Examples

Request example
{
  "method" : "delete",
  "params" : {
    "SelectionCriteria" : {
      "Ids" : [
        13070322
      ]
    }
  }
}
Response example
{
  "result" : {
    "DeleteResults" : [
      {
        "Id" : 13070322
      }
    ]
  }
}