Types

DealUpdate

The body that changes a deal. Send only the fields you change. `status` can't be sent; use the publish, unpublish, archive and restore actions.

name
string
The deal name.
summary
string | null
The short summary shown on deal cards.
description
string | null
The deal description, as HTML. It is sanitised on write.
currency
string
The ISO 4217 currency.
min_investment
number | null
The minimum investment, in major currency units.
available_from
string | null (date-time)
When the deal opens to investment.
available_to
string | null (date-time)
When the deal closes to investment.
structure
string
The deal structure: direct, fund or tradeable.One of: direct, fund, tradeable
sub_structure
string
The deal sub-structure: debt, equity, hybrid, multi_asset, real_assets, real_estate or earthshot_solution.One of: debt, equity, hybrid, multi_asset, real_assets, real_estate, earthshot_solution
type_details
object
The structure-specific details that the legacy `meta` field held, keyed by field name, such as sector or growthStage. Enum-backed values are validated and lower-cased. `GET /deals/lookups` lists the allowed values.
sponsor
string | null
The sponsor name.
show_funding_secured
boolean
Whether investors see how much funding is secured.
allow_questions
boolean
Whether investors can ask questions.
request_further_docs
boolean
Whether investors can request further documents.
external_id
string | null
Your own reference for the deal. It can be changed on a published deal.
transaction_workflow_id
string (uuid)
The transaction workflow investors follow. It can be changed on a published deal, and needs `transaction-workflows:write`.
investor_engagement_enabled
boolean
Whether investors can start investing through the transaction workflow. It can be changed on a published deal, and needs `transactions:write`.
active_tranche_id
string | null (uuid)
The tranche new investments join, or null to clear it. It can be changed on a published deal, and needs `transactions:write`.
tabs
string[]
The whole ordered list of tabs investors see. It must include deal and documents and the id of every custom tab of the deal, repeat no tab, and include team only when the deal has team members. Built-in tabs you leave out are turned off. It can be changed on a published deal.
image_id
string | null (uuid)
The deal image: a file in the deal's assets folder, else 422 `exists`. Null clears it. A published deal returns 409 `invalid_state`.
sponsor_image_id
string | null (uuid)
The sponsor logo: a file in the deal's assets folder, else 422 `exists`. Null clears it. It can be changed on a published deal.
video_id
string | null
The Vimeo video id, digits only. Setting it turns the video tab on and null turns it off, unless `tabs` is sent in the same request. It can be changed on a published deal.

Used by (1)