PATCH
/
v1
/
holders
/
{id}
Update a Holder
curl --request PATCH \
  --url https://crm.sandbox.midaz.io/v1/holders/{id} \
  --header 'Content-Type: application/json' \
  --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": "john.doe@example.com",
    "secondaryEmail": "john.doe@example.com",
    "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": "john.doe@example.com",
      "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": "john.doe@example.com",
    "secondaryEmail": "john.doe@example.com",
    "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": "john.doe@example.com",
      "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. Important: This header only is required if your environment has the Acces Manager plugin enabled.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Path Parameters

​
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.

​
contact
object

Holder's contact information.

​
naturalPerson
object

Information specific to individuals.

​
legalPerson
object

Information specific to legal entities.

​
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'.

Response

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

Holder's details.

​
id
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.

​
contact
object

Holder's contact information.

​
naturalPerson
object

Information specific to individuals.

​
legalPerson
object

Information specific to legal entities.

​
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'.

​
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.