Delete SalesPersons¶

POST /rest/v1/salespersons/delete.json

Permissions Read-Write Sales Person

Method: POST
Path: /rest/v1/salespersons/delete.json
Tag: Sales Persons
Operation ID: deleteSalesPersonUsingPOST

Deletes a list of salesperson records from the target instance. Input records should have only one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Sales Person

Formats¶

Request: application/json
Response: application/json

Request¶

Request body¶

Name: deleteSalesPersonRequest
Required: Yes
Schema: model: DeleteSalesPersonRequest

deleteSalesPersonRequest

Generated example¶

{
  "deleteBy": "string",
  "input": [
    {
      "id": 123,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "seq": 123,
      "status": "created"
    }
  ]
}

Referenced models¶

DeleteSalesPersonRequest

Example request¶

POST {{base_url}}/rest/v1/salespersons/delete.json
Content-Type: application/json
Accept: application/json

{
  "deleteBy": "string",
  "input": [
    {
      "id": 123,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "seq": 123,
      "status": "created"
    }
  ]
}

Responses¶

200 — OK¶

Schema: model: ResponseOfSalesPerson

Generated example¶

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "id": 123,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "seq": 123,
      "status": "created"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models¶

ResponseOfSalesPerson

Source¶

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.