Skip to navigation
API ReferenceRfqs

Update RFQ

Updates mutable fields on an existing RFQ. Only fields included in the request body are modified.

Requires scope: rfqs:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
RFQ ID.

Request

This endpoint expects an object.
namestringOptional
Updated display name. Maximum 255 characters.
noteForSupplierstringOptional

Updated note for suppliers. Omitted or null leaves the current value unchanged.

priorityStatusstringOptional

Updated priority level. Omitted or null leaves the current value unchanged.

Response

This endpoint returns an object.
idUUID
Unique identifier for the RFQ.
supplierCountinteger
Number of suppliers added to this RFQ.
materialCountinteger
Number of material line items in this RFQ.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
rfqNumberlongOptional

Auto-generated sequential reference number for the RFQ.

namestringOptional
Display name of the RFQ.
typestringOptional

RFQ type classification: SINGLE_REQUEST, PROJECT_REQUEST or REPLENISHMENT_REQUEST.

statusenumOptional
Current status of the RFQ.
priorityStatusstringOptional

Priority level: LOW, MEDIUM, HIGH, URGENT or CONTACT_ME. Any other value is rejected with 400.

noteForSupplierstringOptional
Note or instructions visible to suppliers.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error