v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-03432547.1 KB

Services

Patch service attributes

Allows patching below service attributes. Each attribute has its own validation depending on data type. Request can either be a single object or an array of objects. It’s similar to (but not 100% compliant with) JSON Patch.<br>

op	field	example
add	gateway_account_ids	["1"]
replace	redirect_to_service_immediately_on_terminal_state	false
replace	experimental_features_enabled	false
replace	takes_payments_over_phone	false
replace	agent_initiated_moto_enabled	false
replace	collect_billing_address	true
replace	current_go_live_stage	NOT_STARTED
replace	current_psp_test_account_stage	NOT_STARTED
replace	merchant_details/name, organisatio	name
replace	merchant_details/address_line1, Address lin	1
replace	merchant_details/address_line2, Address lin	2
replace	merchant_details/address_city	London
replace	merchant_details/address_country	GB
replace	merchant_details/address_postcode	E6 8XX
replace	merchant_detail	/email,
replace	merchant_details/email, email@exampl	.com
replace	merchant_detail	/url,
replace	merchant_details/url, http://www.exampl	.org
replace	merchant_detail	/telephone_number,
replace	merchant_details/telephone_number	447700900000
replace	custom_branding	{ "css_url": "css url", "image_url": "image url"}
replace	custom_branding	{}
replace	service_name/en	Some service name
replace	sector	local government
replace	internal	true
replace	archived	true
replace	went_live_date	2022-04-09T18:07:46Z
replace	default_billing_address_country	GB
add	feature	test_feature
remove	feature	test_feature

patch/v1/api/services/{serviceExternalId}

Path parameters

serviceExternalIdstring required

Request body

opstring

pathstring

valuestring

Example request

[
  {
    "op": "replace",
    "path": "experimental_features_enabled",
    "value": "false"
  }
]

Response

agent_initiated_moto_enabledboolean

archivedboolean

archived_datestring date-time

collect_billing_addressboolean

created_datestring date-time

current_psp_test_account_stage'NOT_STARTED' | 'REQUEST_SUBMITTED' | 'CREATED'

custom_brandingobject

default_billing_address_countrystring

experimental_features_enabledboolean

external_idstring

gateway_account_idsstring[]

idinteger

internalboolean

namestring

redirect_to_service_immediately_on_terminal_stateboolean

sectorstring

service_featuresobject

service_nameobject

takes_payments_over_phoneboolean

went_live_datestring date-time

Example response

{
  "_links": [
    {
      "href": "https://an.example.link",
      "method": "GET",
      "rel": "self"
    }
  ],
  "archived_date": "2023-04-09T18:07:46.568Z",
  "collect_billing_address": true,
  "created_date": "2022-04-01T12:07:46.568Z",
  "current_go_live_stage": "NOT_STARTED",
  "current_psp_test_account_stage": "NOT_STARTED",
  "custom_branding": {
    "css_url": "css url",
    "image_url": "image url"
  },
  "default_billing_address_country": "GB",
  "external_id": "7d19aff33f8948deb97ed16b2912dcd3",
  "gateway_account_ids": [
    "1"
  ],
  "merchant_details": {
    "address_city": "London",
    "address_country": "GB",
    "address_line1": "Address line 1",
    "address_line2": "Address line 2",
    "address_postcode": "E1 8XX",
    "email": "email@example.com",
    "name": "organisation name",
    "telephone_number": "447700900000",
    "url": "http://www.example.org"
  },
  "name": "Some service name",
  "sector": "local government",
  "service_features": {
    "test_feature": {
      "enabled": true
    },
    "test_feature_2": {
      "enabled": false
    }
  },
  "service_name": {
    "cy": "Service name in welsh",
    "en": "Some service name"
  },
  "went_live_date": "2022-04-09T18:07:46.568Z"
}