Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Unique intent ID. Preserve across retries; use a new value for an intentional new operation.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9_-]+$

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
requestId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
expectedVersion
string
required
Minimum string length: 1

Response

Success

id
string
required
contractId
string | null
required
status
enum<string> | null
required
Available options:
Submitted,
ChangesRequested,
Approved,
Applied,
Rejected,
Cancelled
submissionState
enum<string>
required
Available options:
pending,
sending,
uncertain,
failed,
synced
effectiveDate
string
required
reason
string
required
proposed
object | null
required
original
object | null
required
reviewHistory
object[]
required
version
string
required
createdAt
string
required
appliedAt
string | null
required
canResubmit
boolean
required
canCancel
boolean
required
agreementStatus
string | null
required
notes
string
decreaseDetails
object