Create new My obp_portal_opey_conversation
POST /obp/dynamic-entity/my/obp_portal_opey_conversation
OBPv4.0.0-dynamicEntity_createMyobp_portal_opey_conversation_ No role required _Obp_portal_opey_conversationDynamic-EntityDynamic
Create new My obp_portal_opey_conversation.
A conversation between a User and Opey in the Portal, written by the Portal as the User after each message completes. Personal: each User sees only their own conversations under My Data.
Property List:
- thread_id: Opey thread id of the conversation.
- title: The first user message, shortened.
- status: active or closed.
- started_at: When the first message completed (ISO 8601, UTC).
- updated_at: When the record was last written (ISO 8601, UTC).
- message_count: Number of completed user and assistant messages in messages_json.
- messages_json: The completed messages as a JSON array of {id, role, text, at}.
- consent_reference_ids: Comma-separated consent_reference_ids of the consents Opey used in this conversation; filter the metrics dashboards by them.
- page: Path of the Portal page the chat was embedded in (from the request's Referer), without query string. Empty when unknown.
MethodRouting settings example:
<details>
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"obp_portal_opey_conversation"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
</details>
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
With a Consent: the consent user may use this endpoint only if the Consent lists this entity in my_resources.personal_dynamic_entities with the needed action (read for GET, write otherwise); rows written with a Consent belong to the User who granted it.
Example request body
{
"thread_id": "3f6a2c0e-1b2d-4c3e-9f4a-5b6c7d8e9f00",
"title": "Create a bank called example.bank",
"status": "active",
"started_at": "2026-09-04T10:00:00Z",
"updated_at": "2026-09-04T10:05:00Z",
"message_count": 4,
"messages_json": "[{\"id\":\"u1\",\"role\":\"user\",\"text\":\"Create a bank\",\"at\":\"2026-09-04T10:00:00Z\"}]",
"consent_reference_ids": "c822f56a-3a3e-47f8-b2ec-3afe314ffe7c",
"page": "/app-studio"
}Example success response
{
"obp_portal_opey_conversation": {
"obp_portal_opey_conversation_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
"thread_id": "3f6a2c0e-1b2d-4c3e-9f4a-5b6c7d8e9f00",
"title": "Create a bank called example.bank",
"status": "active",
"started_at": "2026-09-04T10:00:00Z",
"updated_at": "2026-09-04T10:05:00Z",
"message_count": 4,
"messages_json": "[{\"id\":\"u1\",\"role\":\"user\",\"text\":\"Create a bank\",\"at\":\"2026-09-04T10:00:00Z\"}]",
"consent_reference_ids": "c822f56a-3a3e-47f8-b2ec-3afe314ffe7c",
"page": "/app-studio"
}
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-35043: The Consent does not cover this personal resource. A consent user may use a personal (my) endpoint only if the Consent lists the resource in my_resources with the needed action.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.