Skip to main content

Send Message in Feedback


Introduction​

This resource adds a new message to an existing feedback. This is how you reply to a request for clarification made by QI Tech.

How to reply to a feedback

When your message is received, the feedback moves from open to answered. QI Tech is the one that closes the feedback (closed), after evaluating the reply; if it needs anything else, it may open a new feedback, with another feedback_key.

There is no submit to redo: the feedback does not change the analysis status. See Registration analysis lifecycle.

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/feedback/{feedback_key}/message
METHOD
PUT
STATUS
201

Request body​

Request Body
{
"message": "Confirmamos que o endereço declarado permanece válido; o titular reside no imóvel desde 2019.",
"origin_type": "investor_analysis",
"origin_key": "UUID"
}

Body params​

FieldTypeDescriptionCharactersRequired
messagestringMessage content1 - 1000Yes
origin_typestringOrigin Type enumerator. Only investor_analysis is accepted on this route1 - 50Yes
origin_keystringKey of the origin entity (UUID)36Yes
document_b64stringOptional attachment, in base64-No
file_extensionstringAttachment extension: jpeg, pdf or zip. Required when document_b64 is present-Conditional
origin_type and origin_key must match those of the feedback

The pair given in the body must be exactly the same as the one returned by the feedback in List Feedbacks. If there is no feedback with that feedback_key in that origin, the call is rejected with IVR000085.

Response​

The updated feedback is returned in the response body, in the same format as each item of List Feedbacks, already with the new message included in the messages array and with the status set to answered.

Webhook​

Replying does not emit a webhook. investor_registry.feedback_status_change is emitted when QI Tech opens (status: open) or closes (status: closed) a feedback opened by an analyst — see Feedback webhooks.

Errors​

StatusCodeWhen it happens
400IVR000024document_b64 is not valid base64, or was sent without file_extension
400IVR000075origin_type outside the enumerator
404IVR000085There is no feedback with this feedback_key in the given origin
404IVR000011origin_key is not a registration analysis of this investor

Authentication, permission and host errors: see API Errors.