Archive a deal

POST /deals/{id}/archive
Copied
Arrow
                https://api.ocamba.com/v1/hood/deals/{id}/archive

Archives a deal

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
Response status codes
Arrow
204 - No Content
Arrow
400 - Bad Request
Arrow
Name
Description
codeinteger
Http response status code.


Example: 400
messagestring
The human readable message that describes how to deal with error.


Example: Unknown deal id.
titlestring
The error title.


Example: Bad Request.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.

note
1 Archive the deal by the provided Deal ID. Archiving a deal can not be done if a deal is assigned to any active campaign.
tip
1 If you don't know the deal id, list the deals to find it.
warning
1 Archiving a deal will archive all the campaigns the deal is assigned to.

Response examples
Copied
Arrow
400 Arrow
  • 400
  • 500
{
  "code": 400,
  "title": "Bad Request.",
  "message": "Unknown deal id.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}