Update Addressable

User Guide > Resources > Update Addressable

This request edits the attributes of a person, organisation or an object.

See this document for more information on patch requests.

Resource

PATCH /addressables/<OID>

Where OID is the object ID of the addressable.

Parameters

None

Payload

Patch Document

Person Fields

name Patch Operations

commonName

replace

title

replace

initials

replace

givenName

replace

namePrefix

replace

familyName

replace

nameSuffix

replace

additionalNames

replace

gender

replace

communicationLanguage

replace

employments

add, remove, replace submember

dateOfBirth

replace

telecomAddresses

add remove

addresses

add remove

X1Keys

add, remove, replace submember 'key'

Organisation Fields

name Patch Operations

commonName

replace

name

replace

fieldOfBusiness

replace

btwNumber

replace

kvkNumber

replace

telecomAddresses

add remove

addresses

add remove

X1Keys

add, remove, replace submember 'key'

Object Fields

name Patch Operations

commonName

replace

belongsTo

replace (the OID of the reference)

telecomAddresses

add remove

X1Keys

add, remove, replace submember 'key'

Response

None

Context

Authorization

User

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/addressables/5168421
Payload
{
        "operations": [
            {
                "op": "replace",
                   "path": "/fieldOfBusiness",
                "value": "Real Estate"
            },
            {
                "op": "add",
                   "path": "/telecomAddresses/1"
            },
            {
                "op": "replace",
                   "path": "/telecomAddresses/1/address",
                "value": "015-2511411"
            }
    ]
}