Skip to main content
PATCH
Update a Deal
This endpoint is changing in a breaking way as we restructure how Protection Levels work. Contact us at api_support@stora.co and read this guide before starting any integration.

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Path Parameters

deal_id
string
required

The ID of the deal to retrieve

Query Parameters

expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

Body

application/json

Update Deal Request

name
string

The name of the deal

contact
object
stage
object
assignee
object | null

To remove the association, set assignee to null.

site
object | null

To remove the association, set site to null.

note
string | null

Free-text note for the deal. Displayed under 'Deal value estimate' in Backoffice. To remove the existing value, set to null.

starts_at
string<date-time> | null

The intended move-in date. To remove the existing move-in date, set to null.

metadata
object | null

Set of key-value pairs for storing additional information on the deal. Learn more about metadata.

line_items
object[] | null

Skip this property (do not include it inside the request) if you don't want to update the line items. Existing line items not included here in the update request will be removed. To remove all line items, provide an empty array. At most one item per type is allowed.

Maximum array length: 2

Deal Unit Type Line Item

Response

deal updated

Single Deal

deal
object

Deal

meta
object