v1

latestOpenAPI 3.1.02026-08-069158174.8 KB

CRM Service Calls

Patch Order

Update an existing order by ID.

Send only the fields you want to change. Returns 400 if no fields are provided.

Path Parameters:

order_id: The order's CRM record ID.

Request Body (OrderUpdateRequest): Fields: stage, description, total_amount, order_date, order_line_list. All optional — only included fields are updated.

Response: The updated order object.

patch/crm/orders/{order_id}

Path parameters

order_idstring required

Request body

stagestring nullable

Order stage, e.g. draft, pending, approved, fulfilled, cancelled

descriptionstring nullable

Order description / notes

total_amountnumber nullable

Total order amount

order_dateinteger nullable

Order date (epoch timestamp)

Response

Successful Response

idstring required

namestring nullable

stagestring nullable

descriptionstring nullable

order_numstring nullable

order_typestring nullable

order_datestring nullable

total_amountstring nullable

agreement_signed_datestring nullable

created_tsstring nullable

created_ts_datestring nullable

updated_tsstring nullable

updated_ts_datestring nullable

accountstring nullable

primary_sales_agent_emailstring nullable

contactstring nullable

opportunitystring nullable