API Reference

Updates the National Insurance Number for the specified person.

patch
https://{tenant}.rubixx.app/api/v3/people//nationalinsurance

Requires the caller to have the UpdateDetails permission. Returns a not found result if the
specified person does not exist. Returns a bad request result if the update operation is invalid.

Required Permission(s): People.UpdateDetails

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the person whose National Insurance Number is to be updated.

Body Params

An object containing the new National Insurance Number information to apply to the person. Cannot be null.

string
required
length ≥ 1
^([A-Za-z]{2,2}(?: |)(?:[0-9]{2,2}(?: |)){3,3}[A-Za-z]{1,1})$
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?