Update Partner

Use this route to update data of a previously registered partner.

PUTv3/sub_sellers/:sub_seller_id

Request Variable Path

Attribute	Type	Description
sub_seller_id	string	Partner ID.

caution

It is necessary to save the sub_seller_id that Marlim returns in the creation requests in your application. Only with this id will it be possible to proceed with the update.

Request Body Params

Attention

All fields of type string must be informed with alphanumeric characters without accents or special characters.

Attribute	Type	Description
email	string	Partner email.
automatic_anticipation_enabled	boolean	Indicates if the receiver will receive anticipations automatically.
annual_revenue	int32	Estimated annual revenue of the company
website	string	Company website.
phone_number	object	Company phone object.
phone_number[country_code]	string	Company phone country code (DDI), Ex: +55.
phone_number[ddd]	string	Company phone area code.
phone_number[number]	string	Company phone number.
main_address	object	Company main address object.
main_address[country]	string	Address country, in country code format. Only ISO 3166-1 alpha-2 (two-letter) format will be accepted Ex: BR, US, UY... Maximum in characters: 2
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.
status	string	Partner status. Accepted values: active and inactive.
simulate_status	string	Optional parameter to simulate the partner status in test environment, should not be sent in production. Accepted values: active, inactive, pending, or refused.

caution

Restrictions: In production, if the current partner status is pending, refused or blocked, updating is not allowed. The change can only occur when the status is different from these.

In sandbox, to simulate all possible statuses, just inform the simulate_status parameter. If this parameter is not informed, the validation will follow the production restrictions.

Response Object

Attribute	Type	Description
status	string	Partner status. Default value: pending.
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.
email	string	Partner email.
document	string	Partner CNPJ.

Response Example

{
  "status": "active",
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "name": "Empresa Jedi",
  "date_created": "2025-07-07T19:26:42.779Z",
  "date_updated": "2025-07-07T20:26:42.779Z",
  "business_name": "Empresa Jedi LTDA",
  "social_name": "Empresa Jedi",
  "email": "contato@empresajedi.com.br",
  "document": "12345678000190"
}

Examples

Partner Successfully Updated

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 '{
  "email": "novo@empresajedi.com.br",
  "automatic_anticipation_enabled": true,
  "annual_revenue": 1000000000,
  "website": "https://empresajedi.com.br",
  "phone_number": {
    "country_code": "+55",
    "ddd": "11",
    "number": "988888888"
  },
  "main_address": {
    "country": "BR",
    "zip_code": "01234567",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Centro",
    "street": "Rua Jedi",
    "number": "123",
    "complementary": "Sala 45"
  },
  "status": "active"
}'

Response200

{
  "status": "active",
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "name": "Empresa Jedi",
  "date_created": "2025-07-07T19:26:42.779Z",
  "date_updated": "2025-07-07T20:26:42.779Z",
  "business_name": "Empresa Jedi LTDA",
  "social_name": "Empresa Jedi",
  "email": "contato@empresajedi.com.br",
  "document": "12345678000190"
}

Partner Not Found

Request

curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_123456789" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "status": "active"
}'

Response404

{
  "errors": {
    "type": "Sub Seller with id [ sub_123456789 ] was not found."
  }
}

Invalid Status

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 '{
  "status": "invalid_status"
}'

Response400

{
  "errors": {
    "type": "validation",
    "message": "The status provided is invalid. Allowed values are: [ active ], and [ inactive ]."
  }
}