opportunities

Create an opportunity

Create an opportunity, always as a new one. If another system already knows this deal and you are syncing it, use upsert_opportunity, which matches on that system's identity instead of creating a second copy. Omit stageId to use the first open stage of the default pipeline. Amount is an integer in minor units and requires a currency. Set ownerActorId and expectedCloseDate here rather than in a second call: both are filterable and sortable, and recording one fact as two assertions makes the history harder to read than the API.

post/v1/opportunities

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/opportunities
  • Auth: HTTP bearer

Request body

idempotencyKeystring

Your own name for this write, so retrying it cannot do it twice. Send the same key again and you get the SAME result back rather than a second record, which is what makes a re-run safe after a timeout you never saw the answer to. Derive it from what the write is about, not from the clock: nightly-sync-halden retries correctly and a timestamp does not.

expectedVersioninteger

The version you read before deciding to write. If the record has moved since, the write is refused instead of overwriting whatever changed. Send it whenever you read, reasoned, and then wrote: without it the last writer wins and neither of you finds out.

sourceIdstring

The recorded source this claim came from, if one exists. It attaches evidence to the write, so a person reading the field later can see where it came from rather than only who sent it.

assertionKind'observed' | 'inferred' | 'imported' | 'user_supplied'

HOW YOU KNOW. This is the field the product is built around, so say what is true rather than what is strongest: observed you saw it stated directly, imported it came from a file or another system, inferred you worked it out, user_supplied a person told you in so many words. They rank, weakest first: inferred < imported < observed < user_supplied < confirmed. A weaker claim does not overwrite a stronger one; it is reported in held[] and the stored value stands, so an unattended re-run converges instead of eroding what somebody checked. confirmed is not accepted here: it means a person checked the value, and only a signed-in person can set it.

attributionLabelstring

A short name for the work this write belongs to, shown beside the actor so one credential can distinguish separate jobs. It is recorded as CALLER-SUPPLIED and grants nothing: it changes no permission, no idempotency scope and no quota.

dryRunboolean

Report what this write WOULD do and commit nothing. The response carries the same change list, held fields and refusals as the real call, so it is the way to check a risky write, or a whole import, before it lands. Nothing is metered.

overrideStandingboolean

Apply this write even when the value standing in the record was asserted more strongly than this one. Absent means no, which is the safe answer for a re-run. WITHOUT IT, a write can be accepted and change nothing: precedence is confirmed > user_supplied > observed > imported > inferred, and a weaker claim leaves the standing value in place and reports the field in held[] rather than failing. That is the whole of why a write can return 200 and not take. WITH it, this write wins regardless of what it is overruling, INCLUDING a value a person confirmed, so an agent that sets it by default has switched the provenance mechanism off. Set it per write, when the caller knows its claim supersedes what is there.

namestring required
stageIdstring

Only records in this stage. Stage ids come from the schema call, which lists every pipeline and its stages in order.

companyIdstring
amountMinorinteger
currencystring
expectedCloseDatestring
ownerActorIdstring
probabilityBpsinteger
customFieldsobject

Values for fields this workspace defined, keyed by the field's key. Read the schema first: a key that is not declared is REFUSED, with the available keys in the error, rather than stored where nobody will find it. Send null to clear one.

Response

Success

requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.