Description Patches a Person with the given identifier.
Method PATCH
URI Path https://{subdomain}.personalia.webapiservices.com/{version}/persons/{personId}
URI Parameters
{version}
Value alpha

{personId}
Description The identifier of a Person.
Type string
Required true
Headers
Authorization
Description The Authorization header must contain a valid OAuth 2 access token with each request to the Personalia API.
Type string
Required true

Content-Type
Description The format of the body content
Type string
Required true
Permitted Values [application/json, application/xml]
Body Type: JsonPatchOperation[]

PatchDocument example:

[
  {
    "op": "replace",
    "path": "/firstName",
    "value": "John"
  },
  {
    "op": "replace",
    "path": "/gender",
    "value": "2"
  },
  {
    "op": "add",
    "path": "/dateOfBirth",
    "value": "2000/03/24"
  },
  {
    "op": "remove",
    "path": "/title"
  }
]
Success Responses
Code: 204
Description: Returned when the Person entity was succesfully patched.
Error Responses
Code: 400
Description: Returned when the request send to the Personalia API was malformed. The request must be corrected before resending it to the Personalia API.

Code: 401
Description: Returned when no OAuth token is provided or the provided OAuth token is invalid.

Code: 403
Description: Returned when the user is not authorized to perform the action on the resource.

Code: 404
Description: Returned when the Person entity was not found.

Code: 409
Description: Returned when a conflict occured while patching the Person entity

Code: 415
Description: Returned when no Content-Type header is present in the request or the header contains a MIME type that is not supported by the Personalia API.

Code: 422
Description: Returned when validation of the Person entity failed.
Body: Type: Error[]

Code: 500
Description: Returned when an unexpected error occured within the Personalia system. These errors are automaticly logged and reviewed. Please try again, and if the problem persists, please contact our helpdesk.
Body: Type: Error