API Explorer 896 endpoints

Partially update obp_portal_page

PATCH /obp/dynamic-entity/obp_portal_page/OBP_PORTAL_PAGE_ID

OBPv4.0.0-dynamicEntity_patchobp_portal_page_ Roles: CanUpdateDynamicEntityRecord_obp_portal_page(per bank) _Obp_portal_pageDynamic-EntityDynamic

Partially update obp_portal_page: only the fields supplied in the body are changed; others are preserved.

This is also the write path for field-level write-restricted fields (those declared with write_role_required or an explicit write_role). Authorisation is per field present in the body: a write-restricted field requires that field's write role, and an unrestricted field requires the entity update role. You may change a field if (and only if) you hold the role that governs it; the request is rejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update precondition — holding only a field's write role is sufficient to PATCH that field alone.

A page or app authored in App Studio for the OBP Portal. kind=page is HTML+CSS with live-data tags and behaviours (no script); kind=app is a self-contained web app run in a sandboxed iframe. Only status=published records are served by the Portal.

Property List:

  • slug: URL segment under /pages/ on the Portal. Lower-case letters, digits and hyphens.
  • title: Display title.
  • kind: page or app.
  • status: draft or published.
  • summary: One or two sentences for listings.
  • source: The page or app source as written in App Studio.
  • author: Username of the last editor.
  • updated_at: ISO 8601 time of the last save.

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_page"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Example request body
{
  "slug": "hackathon-2026",
  "title": "Open Banking Hackathon 2026",
  "kind": "page",
  "status": "draft",
  "summary": "48-hour hackathon on the sandbox APIs.",
  "source": "<style>…</style><div class=\"lp obp-landing\">…</div>",
  "author": "marketing.team",
  "updated_at": "2026-09-03T10:15:00Z"
}
Example success response
{
  "obp_portal_page": {
    "obp_portal_page_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "slug": "hackathon-2026",
    "title": "Open Banking Hackathon 2026",
    "kind": "page",
    "status": "draft",
    "summary": "48-hour hackathon on the sandbox APIs.",
    "source": "<style>…</style><div class=\"lp obp-landing\">…</div>",
    "author": "marketing.team",
    "updated_at": "2026-09-03T10:15:00Z"
  }
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_patchobp_portal_page_ Originally /obp_portal_page/OBP_PORTAL_PAGE_ID