Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
People

Replace a Person

put/v1/people/{person-id}

Path parameters

person-idstring required

Unique identifier for the person

Example:person_abcdefghijklmno123456

Request body

firstNamestring required

The legal given name of the person.

lastNamestring required

The legal surname or family name of the person.

middleNamestring

An optional middle name of the person, if applicable.

nativeNamestring

The person’s name in their native script (e.g., Cyrillic, Kanji), if different from Latin characters.

birthDatestring date required

The person’s birth date, in ISO-8601 format YYYY-MM-DD.

emailstring email

An email address.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "Michael",
  "nativeName": "道",
  "birthDate": "2000-01-01",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "email": "john.doe@example.com"
}

Response

Person replaced successfully

idstring required

Unique identifier for the person

externalPersonReferencestring

Unique reference, assigned by external client.

firstNamestring required

The legal given name of the person.

lastNamestring required

The legal surname or family name of the person.

middleNamestring

An optional middle name of the person, if applicable.

nativeNamestring

The person’s name in their native script (e.g., Cyrillic, Kanji), if different from Latin characters.

birthDatestring date

The person’s birth date, in ISO-8601 format YYYY-MM-DD.

emailstring email

An email address.

createdAtstring date-time required

Timestamp when the resource was created. UTC timezone. Format YYYY-MM-DDTHH:MM:SS.ssssssZ

updatedAtstring date-time required

Timestamp when the resource was last updated. UTC timezone. Format YYYY-MM-DDTHH:MM:SS.ssssssZ

Example response

{
  "id": "person_abcdefghijklmno123456",
  "externalPersonReference": "REF123",
  "firstName": "John",
  "lastName": "Doe",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "birthDate": "2000-01-01",
  "email": "john.doe@ppro.com",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}