Skip to content
em sa em sa

Bulk archive deals

POST
/api/pipeline/deals/bulk/archive
 
curl --request POST \
  --url https://example.com/api/pipeline/deals/bulk/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deal_ids": [ "example" ] }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
BulkArchiveRequest
object
deal_ids
required
Deal Ids
Array<string>
>= 1 items <= 50 items
Example generated
{
  "deal_ids": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
BulkOperationResponse
object
total
required
Total
integer
succeeded
required
Succeeded
integer
failed
required
Failed
integer
results
required
Results
object
key
additional properties
BulkItemResponse
object
success
required
Success
boolean
error
Any of:
string
Example generated
{
  "total": 1,
  "succeeded": 1,
  "failed": 1,
  "results": {
    "additionalProperty": {
      "success": true,
      "error": "example"
    }
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}