Skip to main content

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

AttributeTypeDescription
sub_seller_idstringPartner ID to be updated.

Request Body Params

AttributeTypeDescription
business_namestringOptional parameter for company Legal Name.
social_namestringOptional parameter for company Trade Name.
emailstringOptional parameter for company email.
phone_numberobjectOptional parameter for company phone object.
phone_number[ddd]stringCompany phone area code.
phone_number[number]stringCompany phone number.
main_addressobjectOptional parameter for company main address object.
main_address[zip_code]stringCompany address ZIP code.
main_address[state]stringCompany address state.
main_address[city]stringCompany address city.
main_address[neighborhood]stringCompany address neighborhood.
main_address[street]stringCompany address street.
main_address[number]stringCompany address number.
main_address[complementary]stringCompany address complement.
managing_partnerobjectOptional parameter for company managing partner object.
managing_partner[name]stringManaging partner name.
managing_partner[phone_number]objectManaging partner phone object.
managing_partner[phone_number][ddd]stringManaging partner phone area code.
managing_partner[phone_number][number]stringManaging partner phone number.
managing_partner[address]objectManaging partner address object.
managing_partner[address][zip_code]stringManaging partner address ZIP code.
managing_partner[address][state]stringManaging partner address state.
managing_partner[address][city]stringManaging partner address city.
managing_partner[address][neighborhood]stringManaging partner address neighborhood.
managing_partner[address][street]stringManaging partner address street.
managing_partner[address][number]stringManaging partner address number.
managing_partner[address][complementary]stringManaging partner address complement.
bank_accountobjectOptional parameter for company bank account object.
bank_account[bank]stringBank code.
bank_account[agency]stringAgency number.
bank_account[agency_digit]stringAgency digit.
bank_account[account_number]stringAccount number.
bank_account[account_digit]stringAccount digit.
bank_account[type]stringAccount type. Accepted values: checking or savings.
bank_account[pix]objectPix key data object.
bank_account[pix][type]stringPix key type.
Accepted values: cpf, cnpj, email or phone.
bank_account[pix][key]stringPix 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

AttributeTypeDescription
statusstringPartner status.
sub_seller_idstringPartner ID.
namestringPartner name.
date_createddateTimePartner creation date in ISODateTime format.
date_updateddateTimePartner update date in ISODateTime format.
business_namestringPartner Legal Name.
social_namestringPartner Trade Name.
emailstringPartner email.
documentstringPartner 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

Request
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"
}'
Response200
{
"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"
}