Update Partner
This route is used to update partner data. You must pass the sub_seller_id in the endpoint PATH and the data to be updated in the request body.
PUTv3/sub_sellers/:sub_seller_id
Request Variable Path
| Attribute | Type | Description |
|---|---|---|
| sub_seller_id | string | Partner ID to be updated. |
Request Body Params
| Attribute | Type | Description |
|---|---|---|
| business_name | string | Optional parameter for company Legal Name. |
| social_name | string | Optional parameter for company Trade Name. |
| string | Optional parameter for company email. | |
| phone_number | object | Optional parameter for company phone object. |
| phone_number[ddd] | string | Company phone area code. |
| phone_number[number] | string | Company phone number. |
| main_address | object | Optional parameter for company main address object. |
| main_address[zip_code] | string | Company address ZIP code. |
| main_address[state] | string | Company address state. |
| main_address[city] | string | Company address city. |
| main_address[neighborhood] | string | Company address neighborhood. |
| main_address[street] | string | Company address street. |
| main_address[number] | string | Company address number. |
| main_address[complementary] | string | Company address complement. |
| managing_partner | object | Optional parameter for company managing partner object. |
| managing_partner[name] | string | Managing partner name. |
| managing_partner[phone_number] | object | Managing partner phone object. |
| managing_partner[phone_number][ddd] | string | Managing partner phone area code. |
| managing_partner[phone_number][number] | string | Managing partner phone number. |
| managing_partner[address] | object | Managing partner address object. |
| managing_partner[address][zip_code] | string | Managing partner address ZIP code. |
| managing_partner[address][state] | string | Managing partner address state. |
| managing_partner[address][city] | string | Managing partner address city. |
| managing_partner[address][neighborhood] | string | Managing partner address neighborhood. |
| managing_partner[address][street] | string | Managing partner address street. |
| managing_partner[address][number] | string | Managing partner address number. |
| managing_partner[address][complementary] | string | Managing partner address complement. |
| bank_account | object | Optional parameter for company bank account object. |
| bank_account[bank] | string | Bank code. |
| bank_account[agency] | string | Agency number. |
| bank_account[agency_digit] | string | Agency digit. |
| bank_account[account_number] | string | Account number. |
| bank_account[account_digit] | string | Account digit. |
| bank_account[type] | string | Account type. Accepted values: checking or savings. |
| bank_account[pix] | object | Pix key data object. |
| bank_account[pix][type] | string | Pix key type. Accepted values: cpf, cnpj, email or phone. |
| bank_account[pix][key] | string | Pix key value. Must be informed according to the Pix key type. |
Request Body Example
{
"business_name": "Empresa Jedi Atualizada LTDA",
"social_name": "Empresa Jedi Atualizada",
"email": "contato@empresajediatualizada.com.br",
"phone_number": {
"ddd": "11",
"number": "999999999"
},
"main_address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi Atualizada",
"number": "456",
"complementary": "Sala 78"
},
"managing_partner": {
"name": "Luke Skywalker Atualizado",
"phone_number": {
"ddd": "11",
"number": "988888888"
},
"address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi Atualizada",
"number": "456",
"complementary": "Apto 78"
}
},
"bank_account": {
"bank": "001",
"agency": "5678",
"agency_digit": "9",
"account_number": "654321",
"account_digit": "1",
"type": "savings",
"pix": {
"type": "email",
"key": "contato@empresajediatualizada.com.br"
}
}
}
Response Object
| Attribute | Type | Description |
|---|---|---|
| status | string | Partner status. |
| sub_seller_id | string | Partner ID. |
| name | string | Partner name. |
| date_created | dateTime | Partner creation date in ISODateTime format. |
| date_updated | dateTime | Partner update date in ISODateTime format. |
| business_name | string | Partner Legal Name. |
| social_name | string | Partner Trade Name. |
| string | Partner email. | |
| document | string | Partner CNPJ. |
Response Example
{
"status": "pending",
"sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
"name": "Empresa Jedi Atualizada",
"date_created": "2025-07-07T19:26:42.779Z",
"date_updated": "2025-07-07T21:26:42.779Z",
"business_name": "Empresa Jedi Atualizada LTDA",
"social_name": "Empresa Jedi Atualizada",
"email": "contato@empresajediatualizada.com.br",
"document": "12345678000190"
}
Examples
- Partner Updated Successfully
- Partner Not Found
curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
"business_name": "Empresa Jedi Atualizada LTDA",
"social_name": "Empresa Jedi Atualizada",
"email": "contato@empresajediatualizada.com.br"
}'
{
"status": "pending",
"sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
"name": "Empresa Jedi Atualizada",
"date_created": "2025-07-29T11:38:57.747Z",
"date_updated": "2025-07-29T11:38:57.747Z",
"business_name": "Empresa Jedi Atualizada LTDA",
"social_name": "Empresa Jedi Atualizada",
"email": "contato@empresajediatualizada.com.br",
"document": "12345678000190"
}
curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_inexistente" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
"business_name": "Empresa Jedi Atualizada LTDA"
}'
{
"api_reference": "https://docs.api.marlim.co/sub_sellers/update",
"errors": [
{
"type": "not_found",
"message": "Partner with ID 'sub_inexistente' was not found."
}
]
}