Update affiliated person

Request

Update records of an affiliated person object in our system

Security

API-Key

Path

affiliated_person_idstring, = 36 charactersrequired

A unique identifier of an affiliated person object, that is assigned by our system after an affiliated person object was created with a “Create an affiliated person” request

Example:27c5caea93ee4656881ef9a30fadd21a3768

Bodyapplication/json

first_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The first name of a person

Example:"Josh"

last_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The last name of a person

Example:"Coffey"

titlestring or null, [ 1 .. 36 ] characters

A title of an authorised affiliated person object in a company

Example:"CDO"

dobstring or null, (date)

The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601

Example:"1976-02-21"

residence_countrystring or null, = 2 characters

A residence country of an object. A two-letter country code according to ISO 3166-2

Example:"GB"

nationalitystring or null, = 2 characters

A nationality country of a person. A two-letter country code according to ISO 3166-2

Example:"GB"

emailstring or null, (email), [ 1 .. 254 ] characters

The email address of a person or a company

Example:"josh.coffey@example.com"

{
  "first_name": "Josh",
  "last_name": "Coffey",
  "title": "CDO",
  "share": 13.05,
  "dob": "1976-02-21",
  "residence_country": "GB",
  "nationality": "GB",
  "email": "josh.coffey@example.com"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json

affiliated_person_idstring, = 36 characters

A unique identifier of an affiliated person object, that is assigned by our system after an affiliated person object was created with a “Create an affiliated person” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

Response

{
  "affiliated_person_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}