DealSleek API · Intelligence
PreviewPropose Intelligence Recommendation
/api/v1/intelligence/dispatchHeaders
AuthorizationstringRequiredAccess token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequiredNames the command to run. Must be
PROPOSE_INTELLIGENCE_RECOMMENDATIONfor this endpoint.Content-TypestringRequiredAlways
application/json.X-Idempotency-KeystringOptionalA key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptionalYour own identifier for the request. Returned in the
x-correlation-idresponse header; generated when you leave it out.
Request body
assessment_iduuidRequiredNo description yet.
proposalobjectRequiredNo description yet.
6 child fields
evidenceIdsarray of uuidRequiredNo description yet.
expiresAtdate-timeRequiredNo description yet.
iduuidRequiredNo description yet.
kindenumRequiredNo description yet.
- Allowed values
- VERIFY_EVIDENCE
- CONTACT_OWNER
- REVIEW_DEAL
- REFRESH_ASSESSMENT
ownerIduuidRequiredNo description yet.
rationalestringRequiredNo description yet.
mitigationbooleanOptionalNo description yet.
- Default
- false
Response
Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.
Errors
Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.
- 400
X-CQRS-Actionis missing or names a command this route does not accept. SendPROPOSE_INTELLIGENCE_RECOMMENDATION. - 400
DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types. - 401The access token is missing, expired or not valid.
- 401
L1_AUTHThe caller's role is belowmanageror the caller has no access to this record. - 403
L1_POLICYA business rule refused the command. The message names the rule. - 409
L1_IDEMPOTENCYA command with this idempotency key was already applied. - 409
CONFLICTThe command would duplicate a record that must be unique. - 500
L3_COMMITThe command was valid but could not be saved.