Skip to content

DeleteCompanyRequest

Type: object

Properties

Property Type Required Description Constraints
deleteBy string No Field to delete company records by. Key may be "dedupeFields" or "idField"
input array No List of company objects. Companies in the list should only contain a member matching the dedupeBy value. Each 'Company' object contains a 'searchableField' for lookup purposes which can be retrieved using the Describe Companies endpoint

Generated example

{
  "deleteBy": "string",
  "input": [
    {
      "externalCompanyId": "123",
      "id": 123,
      "company": "string"
    }
  ]
}

Referenced models

Source

Generated from swagger-mapi.json.