Reference
Create a deal
Creates a pipeline deal (opportunity) in the gallery.
Creates a pipeline deal (opportunity) in the gallery.
Authorization
bearerAuth deals:createAuthorizationBearer <token>
A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: deals:create
Header Parameters
Idempotency-Key?string
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Create a deal.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "contact_id": "string", "stage_id": "string", "title": "string", "status": "open", "expected_value_cents": -9007199254740991, "currency": "string", "owner_id": "string", "expected_close_date": "string", "won_sale_id": "string", "notes": "string", "position": -9007199254740991, "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}