v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Quote

Quotes.update

Modifies Quote or Quotes with given id(s)

patch/entities/Quotes/{id}

Path parameters

idstring uuid required

ID of Quote to update

Query parameters

validation-levelinteger

Specify validation level of Quote on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this quote.

descriptionstring

Free-form description of the quote.

expiration_datestring date

Date after which the quote is no longer considered valid.

is_archivedboolean

True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated.

namestring

Name of the entity and its default text representation.

oppty_idstring uuid

Id of the opportunity.

owner_idstring uuid

Id of the quote owner.

product_currency_idstring uuid

Id of the product currency.

product_price_list_idstring uuid

Id of the product price list.

product_sectionsobject

Product sections grouping the record's line items, as a JSON array of {"id": <UUID>, "name": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html

quick_account_emailstring

Free-text company email captured at quote creation when no Account record has been linked yet.

quick_account_namestring

Free-text company name captured at quote creation when no Account record has been linked yet.

quick_account_phonestring

Free-text company phone captured at quote creation when no Account record has been linked yet.

quick_contact_namestring

Free-text contact name captured at quote creation when no Contact record has been linked yet.

quick_emailstring

Free-text contact email captured at quote creation when no Contact record has been linked yet.

quick_phonestring

Free-text contact phone captured at quote creation when no Contact record has been linked yet.

quote_type_idstring uuid

Id of the quote type.

reason_of_close_descriptionstring

Free-form note explaining why the quote was archived (lost).

reason_of_close_idstring uuid

Id of the reason-of-close value.

share_mode0 | 1 | 2 | 3

Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

step_idstring uuid

Id of the quote-process step.

unit_idstring uuid

Id of the sales unit.

versioninteger

Revision number of the quote, incremented when a new version of the same quote is created.

revisioninteger

Revision when entity was lastly changed.

is_active_in_opportunityboolean

If quote is set as active in opportunity.

Example request

{
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "expiration_date": "2019-01-01",
  "name": "string",
  "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "quick_account_email": "string",
  "quick_account_name": "string",
  "quick_account_phone": "string",
  "quick_contact_name": "string",
  "quick_email": "string",
  "quick_phone": "string",
  "quote_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "reason_of_close_description": "string",
  "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
  "step_id": "01234567-abcd-dcba-ffff-000000000000",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "version": 1,
  "revision": 1,
  "total_amount": {
    "currency_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}

Response

Modification confirmation. Returns resulting Quote

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "expiration_date": "2019-01-01",
    "name": "string",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_account_email": "string",
    "quick_account_name": "string",
    "quick_account_phone": "string",
    "quick_contact_name": "string",
    "quick_email": "string",
    "quick_phone": "string",
    "quote_number": "string",
    "quote_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "reason_of_close_description": "string",
    "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "version": 1,
    "revision": 1,
    "total_amount": {
      "currency_id": "01234567-abcd-dcba-ffff-000000000000"
    },
    "status": 1,
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}