Hibernate Lead

Put a lead on hold for later re-engagement. Specifies a wake trigger.

POST/api/v1/leads/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/leads/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: HIBERNATE_LEAD" \
  -H "Content-Type: application/json" \
  -d '{
    "expected_trigger": "FUNDING_ROUND",
    "lead_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: Sales repThe caller must hold this role or a higher one.
Action: HIBERNATE_LEAD

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be HIBERNATE_LEAD for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

expected_triggerenumRequired
No description yet.
Allowed values
- FUNDING_ROUND
- EXECUTIVE_CHANGE
- COMPETITOR_CONTRACT_EXPIRING
- SEMANTIC_WEB_SIGNAL
- INBOUND_ENQUIRY
lead_iduuidRequired
No description yet.
current_stateenum or nullOptional
Real current state (Go). When present, the transition to CryoSleep is validated; absent = legacy (skip).
Allowed values
- DISCOVERED
- ENGAGED
- CRYO_SLEEP
- RESURRECTED
- CONVERTED
- DISQUALIFIED
expected_versioninteger or nullOptional
No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send HIBERNATE_LEAD.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below rep or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_VERSIONexpected_version is not the record's current version. Read the record again, then retry.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.