Update a Holder

curl --request PATCH \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '
{
  "externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
  "name": "ACME Corp LTD",
  "addresses": {
    "primary": {
      "line1": "Rua Botucatu 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "description": "BR address"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "US address"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "UK address"
    }
  },
  "contact": {
    "primaryEmail": "[email protected]",
    "secondaryEmail": "[email protected]",
    "mobilePhone": "5577927967227",
    "otherPhone": "556829443019"
  },
  "naturalPerson": {
    "favoriteName": "Timothy Bode",
    "socialName": "Dr. Ervin Keebler",
    "gender": "male",
    "birthDate": "1990-10-12",
    "civilStatus": "Married",
    "nationality": "Brazilian",
    "motherName": "Hector Jaskolski",
    "fatherName": "Ms. Carolyn Weber",
    "status": "Active"
  },
  "legalPerson": {
    "activity": "Electronic devices development",
    "foundingDate": "2025-01-01",
    "representative": {
      "document": "91315026015",
      "email": "[email protected]",
      "name": "John Doe",
      "role": "CFO"
    },
    "size": "Medium",
    "status": "Closed",
    "tradeName": "Lerian Studio",
    "type": "Limited Liability"
  },
  "metadata": {
    "metadata1": "value1",
    "metadata2": 2
  }
}
'

{
  "id": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
  "externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
  "type": "LEGAL_PERSON",
  "name": "ACME Corp LTD",
  "document": "91315026015",
  "addresses": {
    "primary": {
      "line1": "Rua Botucatu 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "description": "BR address"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "US address"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "UK address"
    }
  },
  "contact": {
    "primaryEmail": "[email protected]",
    "secondaryEmail": "[email protected]",
    "mobilePhone": "5577927967227",
    "otherPhone": "556829443019"
  },
  "naturalPerson": {
    "favoriteName": "Timothy Bode",
    "socialName": "Dr. Ervin Keebler",
    "gender": "male",
    "birthDate": "1990-10-12",
    "civilStatus": "Married",
    "nationality": "Brazilian",
    "motherName": "Hector Jaskolski",
    "fatherName": "Ms. Carolyn Weber",
    "status": "Active"
  },
  "legalPerson": {
    "activity": "Electronic devices development",
    "foundingDate": "2025-01-01",
    "representative": {
      "document": "91315026015",
      "email": "[email protected]",
      "name": "John Doe",
      "role": "CFO"
    },
    "size": "Medium",
    "status": "Closed",
    "tradeName": "Lerian Studio",
    "type": "Limited Liability"
  },
  "metadata": {
    "metadata1": "value1",
    "metadata2": 2
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "deletedAt": null
}

PATCH

holders

{holder_id}

Update a Holder

curl --request PATCH \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '
{
  "externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
  "name": "ACME Corp LTD",
  "addresses": {
    "primary": {
      "line1": "Rua Botucatu 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "description": "BR address"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "US address"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "UK address"
    }
  },
  "contact": {
    "primaryEmail": "[email protected]",
    "secondaryEmail": "[email protected]",
    "mobilePhone": "5577927967227",
    "otherPhone": "556829443019"
  },
  "naturalPerson": {
    "favoriteName": "Timothy Bode",
    "socialName": "Dr. Ervin Keebler",
    "gender": "male",
    "birthDate": "1990-10-12",
    "civilStatus": "Married",
    "nationality": "Brazilian",
    "motherName": "Hector Jaskolski",
    "fatherName": "Ms. Carolyn Weber",
    "status": "Active"
  },
  "legalPerson": {
    "activity": "Electronic devices development",
    "foundingDate": "2025-01-01",
    "representative": {
      "document": "91315026015",
      "email": "[email protected]",
      "name": "John Doe",
      "role": "CFO"
    },
    "size": "Medium",
    "status": "Closed",
    "tradeName": "Lerian Studio",
    "type": "Limited Liability"
  },
  "metadata": {
    "metadata1": "value1",
    "metadata2": 2
  }
}
'

{
  "id": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
  "externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
  "type": "LEGAL_PERSON",
  "name": "ACME Corp LTD",
  "document": "91315026015",
  "addresses": {
    "primary": {
      "line1": "Rua Botucatu 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "description": "BR address"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "US address"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "UK address"
    }
  },
  "contact": {
    "primaryEmail": "[email protected]",
    "secondaryEmail": "[email protected]",
    "mobilePhone": "5577927967227",
    "otherPhone": "556829443019"
  },
  "naturalPerson": {
    "favoriteName": "Timothy Bode",
    "socialName": "Dr. Ervin Keebler",
    "gender": "male",
    "birthDate": "1990-10-12",
    "civilStatus": "Married",
    "nationality": "Brazilian",
    "motherName": "Hector Jaskolski",
    "fatherName": "Ms. Carolyn Weber",
    "status": "Active"
  },
  "legalPerson": {
    "activity": "Electronic devices development",
    "foundingDate": "2025-01-01",
    "representative": {
      "document": "91315026015",
      "email": "[email protected]",
      "name": "John Doe",
      "role": "CFO"
    },
    "size": "Medium",
    "status": "Closed",
    "tradeName": "Lerian Studio",
    "type": "Limited Liability"
  },
  "metadata": {
    "metadata1": "value1",
    "metadata2": 2
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "deletedAt": null
}

Headers

Authorization

string

The authorization token in the 'Bearer ' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

X-Organization-id

string

required

The unique identifier of the Organization associated with the request.

Example:

"01946120-0f45-7c5f-86a0-0ea7c59fdbd4"

Path Parameters

holder_id

string

required

Unique identifier of the holder you want to update.

Body

application/json

User's details that will be updated.

externalId

string

Optional field for linking this Holder to an external system.

name

string

Full name of the Holder. Note: Use the legal name for companies (Legal Person). For individuals (Natural Person), use their full name.

addresses

object

Holder's address information.

Show child attributes

addresses.primary

object

Details about the primary address.

Show child attributes

addresses.primary.line1

string

Street name and building number.

addresses.primary.line2

string

Extra address details, for example, apartment or suite number.

addresses.primary.zipCode

string

Postal or ZIP code.

addresses.primary.city

string

City where the address is located.

addresses.primary.state

string

State, province, or region.

addresses.primary.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.primary.description

string

A label to help identify this address.

addresses.additional1

object

Details about a specific address.

Show child attributes

addresses.additional1.line1

string

Street name and building number.

addresses.additional1.line2

string

Extra address details, for example, apartment or suite number.

addresses.additional1.zipCode

string

Postal or ZIP code.

addresses.additional1.city

string

City where the address is located.

addresses.additional1.state

string

State, province, or region.

addresses.additional1.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.additional1.description

string

A label to help identify this address.

addresses.additional2

object

Details about a specific address.

Show child attributes

addresses.additional2.line1

string

Street name and building number.

addresses.additional2.line2

string

Extra address details, for example, apartment or suite number.

addresses.additional2.zipCode

string

Postal or ZIP code.

addresses.additional2.city

string

City where the address is located.

addresses.additional2.state

string

State, province, or region.

addresses.additional2.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.additional2.description

string

A label to help identify this address.

contact

object

Holder's contact information.

Show child attributes

contact.primaryEmail

string

The primary email used to contact the holder.

contact.secondaryEmail

string

The secondary email used to contact the holder.

contact.mobilePhone

string

The mobile phone number used to contact the holder, including country code.

contact.otherPhone

string

Any additional phone number used to contact the holder.

naturalPerson

object

Information specific to individuals.

Show child attributes

naturalPerson.favoriteName

string

Nickname or preferred name.

Social name, if different from the legal name.

naturalPerson.gender

string

Gender identity of the person.

naturalPerson.birthDate

string<date>

Date of birth in YYYY-MM-DD format.

naturalPerson.civilStatus

string

Civil status — for example: Single, Married, or Divorced.

naturalPerson.nationality

string

Nationality, for example, Brazilian.

naturalPerson.motherName

string

Mother's full name.

naturalPerson.fatherName

string

Father's full name.

naturalPerson.status

string

Current status of the individual in the system.

legalPerson

object

Information specific to legal entities.

Show child attributes

legalPerson.activity

string

The type of business or activity the company engages in.

legalPerson.foundingDate

string

The date when the company was established.

legalPerson.representative

object

Details of the company's legal representative.

Show child attributes

legalPerson.representative.document

string

The document number of the legal representative.

legalPerson.representative.email

string

The email address of the legal representative.

legalPerson.representative.name

string

The legal representative's name.

legalPerson.representative.role

string

The role of the legal representative within the company.

legalPerson.size

string

The size classification of the company.

legalPerson.status

string

The current status of the company.

legalPerson.tradeName

string

The registered business name of the company, if applicable.

legalPerson.type

string

The legal structure of the company.

metadata

object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes

metadata.{key}

string

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Holder's details.

string

Unique identifier of the Holder.

externalId

string

Optional field for linking this Holder to an external system.

type

enum<string>

Defines if the Holder is an individual or a company.

NATURAL_PERSON – Individual
LEGAL_PERSON – Company

Available options:

NATURAL_PERSON,

LEGAL_PERSON

name

string

Full name of the Holder.

document

string

Holder's identification number (such as CPF or CNPJ).

addresses

object

Holder's address information.

Show child attributes

addresses.primary

object

Details about the primary address.

Show child attributes

addresses.primary.line1

string

Street name and building number.

addresses.primary.line2

string

Extra address details, for example, apartment or suite number.

addresses.primary.zipCode

string

Postal or ZIP code.

addresses.primary.city

string

City where the address is located.

addresses.primary.state

string

State, province, or region.

addresses.primary.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.primary.description

string

A label to help identify this address.

addresses.additional1

object

Details about a specific address.

Show child attributes

addresses.additional1.line1

string

Street name and building number.

addresses.additional1.line2

string

Extra address details, for example, apartment or suite number.

addresses.additional1.zipCode

string

Postal or ZIP code.

addresses.additional1.city

string

City where the address is located.

addresses.additional1.state

string

State, province, or region.

addresses.additional1.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.additional1.description

string

A label to help identify this address.

addresses.additional2

object

Details about a specific address.

Show child attributes

addresses.additional2.line1

string

Street name and building number.

addresses.additional2.line2

string

Extra address details, for example, apartment or suite number.

addresses.additional2.zipCode

string

Postal or ZIP code.

addresses.additional2.city

string

City where the address is located.

addresses.additional2.state

string

State, province, or region.

addresses.additional2.country

string

Two-letter country code (ISO 3166-1 alpha-2).

addresses.additional2.description

string

A label to help identify this address.

contact

object

Holder's contact information.

Show child attributes

contact.primaryEmail

string

The primary email used to contact the holder.

contact.secondaryEmail

string

The secondary email used to contact the holder.

contact.mobilePhone

string

The mobile phone number used to contact the holder, including country code.

contact.otherPhone

string

Any additional phone number used to contact the holder.

naturalPerson

object

Information specific to individuals.

Show child attributes

naturalPerson.favoriteName

string

Nickname or preferred name.

Social name, if different from the legal name.

naturalPerson.gender

string

Gender identity of the person.

naturalPerson.birthDate

string<date>

Date of birth in YYYY-MM-DD format.

naturalPerson.civilStatus

string

Civil status — for example: Single, Married, or Divorced.

naturalPerson.nationality

string

Nationality, for example, Brazilian.

naturalPerson.motherName

string

Mother's full name.

naturalPerson.fatherName

string

Father's full name.

naturalPerson.status

string

Current status of the individual in the system.

legalPerson

object

Information specific to legal entities.

Show child attributes

legalPerson.activity

string

The type of business or activity the company engages in.

legalPerson.foundingDate

string

The date when the company was established.

legalPerson.representative

object

Details of the company's legal representative.

Show child attributes

legalPerson.representative.document

string

The document number of the legal representative.

legalPerson.representative.email

string

The email address of the legal representative.

legalPerson.representative.name

string

The legal representative's name.

legalPerson.representative.role

string

The role of the legal representative within the company.

legalPerson.size

string

The size classification of the company.

legalPerson.status

string

The current status of the company.

legalPerson.tradeName

string

The registered business name of the company, if applicable.

legalPerson.type

string

The legal structure of the company.

metadata

object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes

metadata.{key}

string

createdAt

string

Date when the Holder was created.

deletedAt

string

Date when the Holder was deleted.

updatedAt

string

Date when the Holder was last updated.

Retrieve a Holder

Delete a Holder

⌘I

CRM

Fees Engine

Direct Pix

Update a Holder

Headers

Path Parameters

Body

Response