Update Routing Scheme
PUT /obp/v7.0.0/routing-schemes/SCHEME
OBPv7.0.0-updateRoutingScheme Roles: CanUpdateRoutingScheme Routing-Scheme
Updates a routing scheme. All body fields are optional.
Immutable fields (cannot be changed via this endpoint): scheme, country, category.
If you tighten address_pattern, existing addresses already on the books are not retroactively rejected — the change applies only to new validations.
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
SCHEME: OBP
JSON response body fields (11)
- address_pattern
- address_pattern
- category
- country
- Germany
- created_at
- created_at
- created_by_user_id
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- downstream_rails
- downstream_rails
- example_address
- example_address
- scheme
- OBP
- status
- updated_at
- updated_at
Example request body
{
"address_pattern": "^255[0-9]{9}$",
"example_address": "255778300336",
"description": "Tanzanian mobile number, E.164 without leading +.",
"downstream_rails": [
"TIPS",
"MNO_DIRECT"
],
"status": "ACTIVE"
}Example success response
{
"scheme": "TZ.MSISDN",
"country": "TZ",
"category": "ACCOUNT",
"address_pattern": "^255[0-9]{9}$",
"example_address": "255778300336",
"description": "Tanzanian mobile number, E.164 without leading +.",
"downstream_rails": [
"TIPS",
"MNO_DIRECT"
],
"status": "ACTIVE",
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_at": "2026-10-21T01:45:41Z",
"updated_at": "2026-10-21T01:45:41Z"
}Possible errors (9)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-30514: Routing Scheme not found. Please specify a valid value for SCHEME.
- OBP-30519: Invalid Routing Scheme status. Allowed values are: ACTIVE, RESERVED, DEPRECATED, RETIRED.
- OBP-30520: Invalid Routing Scheme address_pattern. The value must be a valid regular expression.
- OBP-30521: Routing Scheme example_address does not match address_pattern.
- OBP-30523: Could not update Routing Scheme.
- OBP-50000: Unknown Error.