Skip to content

Set Rival Attach

POST
/deals/{deal_id}/rival-attach

Record which competitor is on this deal, and how it is going.

A null competitor_id DETACHES the current one - the same route both attaches and clears.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id (UUID).

string

Deal id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Record which competitor is on a deal, and how it is going.

object
competitor_id
Any of:
string
status
required

Where the deal stands against them.

string

Responses

200

Successful Response

object
data
required

An open envelope for a deal, a merge preview or a column result.

Open because the crossfire and merge-preview payloads are computed shapes that grow with the product, and a closed model would drop a field from an ADVISORY read - where a missing signal reads as “nothing to worry about” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string