Update bid

PATCH

/bids/{id}

• Production

Partially updates a bid. Accepted bids are locked.

Authorizations

• bearerAuth
  bids:write

Parameters

Path Parameters

id

required

integer

Request Body

object

bidNumber

string

name

string | null

<= 255 characters

leadId

integer | null

>= -2147483648 <= 2147483647

contactId

integer | null

>= -2147483648 <= 2147483647

projectId

integer | null

>= -2147483648 <= 2147483647

dueDate

string | null

validUntil

string | null

sentAt

string | null

acceptedAt

string | null

acceptedBy

string | null

<= 255 characters

rejectedAt

string | null

taxRate

string | null

discountType

string | null

<= 20 characters

discount

string | null

siteAddress

string | null

latitude

string | null

longitude

string | null

notes

string | null

terms

string | null

paymentTermsText

string | null

paymentTermId

integer | null

>= -2147483648 <= 2147483647

createdBy

integer | null

>= -2147483648 <= 2147483647

marginPercent

string | null

companyOhPercent

string | null

commissionPercent

string | null

showSublines

boolean | null

roundSalesAmounts

boolean | null

kanbanOrder

integer

>= -2147483648 <= 2147483647

Responses

200

Updated

object

data

required

object

id

required

integer

bidNumber

required

string

contactId

required

integer | null

leadId

required

integer | null

projectId

required

integer | null

status

required

string

subtotal

required

string | null

taxAmount

required

string | null

total

required

string | null

taxRate

required

string | null

discount

required

string | null

discountType

required

string | null

validUntil

required

Any of:

string

string format: date-time

string

string

null

null

notes

required

string | null

terms

required

string | null

siteAddress

required

string | null

sentAt

required

Any of:

string

string format: date-time

string

string

null

null

acceptedAt

required

Any of:

string

string format: date-time

string

string

null

null

acceptedBy

required

string | null

createdAt

required

Any of:

string

string format: date-time

string

string

updatedAt

required

Any of:

string

string format: date-time

string

string

meta

required

object

request_id

Server-generated request identifier

string

pagination

object

cursor

required

Opaque cursor for the next page; null when no more results

string | null

has_more

required

Whether more pages are available after this one

boolean

count

required

Items in this page

integer

404

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string

409

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string

422

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string