Skip to main content
PUT
/
v0
/
branch
/
{branch_id}
Update Branch
curl --request PUT \
  --url https://public-api.salu.com.vc/dev/routes/v0/branch/{branch_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "company_name": "<string>",
  "cnpj": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "<string>",
  "address_number": "<string>",
  "address_detail": "<string>",
  "zip_code": "<string>",
  "neighborhood": "<string>",
  "state": "<string>",
  "city": "<string>",
  "is_active": true,
  "hr_code": "<string>",
  "cnae": "<string>",
  "client_integration_code": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "company_name": "<string>",
  "cnpj": "<string>",
  "is_active": true,
  "address": "<string>",
  "address_number": "<string>",
  "address_detail": "<string>",
  "zip_code": "<string>",
  "neighborhood": "<string>",
  "state": "<string>",
  "city": "<string>",
  "hr_code": "<string>",
  "client_integration_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.salu.com.vc/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint updates a branch. It accepts the BranchRequestUpdateSchema as the request body and returns PublicApiBranchBaseResponse on success.
This endpoint does not behave like a PATCH. A PUT request replaces the entire resource. If you omit fields in the body, they may be overwritten with default or null values.

​
Overview

  • Method: PUT
  • Path: /v0/branch/{branch_id}
  • OperationId: public_update_branch_v0_branch__branch_id__put
  • Authentication: header x-api-key (APIKeyHeader in the OpenAPI)

​
Fields

  1. cnpj — Company / Branch identifier A CNPJ (Cadastro Nacional da Pessoa Jurídica) is the tax ID for a legal entity (company). A single company group may have multiple CNPJs, because each branch/worksite can have its own legal registration (branch-specific CNPJ). In our model, the Branch is identified by cnpj because that defines the legal employer entity responsible for compliance.

​
Example Request

curl -X PUT "https://public-api.salu.com.vc/dev/routes/v0/branch/{branch_id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY" \
  -d @branch_update_payload.json

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
branch_id
string<uuid>
required

Body

application/json
​
display_name
string
required
​
company_name
string
required
​
cnpj
string
required
​
organization_id
string<uuid>
required
​
address
string | null
​
address_number
string | null
​
address_detail
string | null
​
zip_code
string | null
​
neighborhood
string | null
​
state
string | null
​
city
string | null
​
is_active
boolean
default:true
​
hr_code
string | null
​
cnae
string | null
​
client_integration_code
string | null

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
display_name
string
required
​
company_name
string
required
​
cnpj
string
required
​
is_active
boolean
required
​
address
string | null
​
address_number
string | null
​
address_detail
string | null
​
zip_code
string | null
​
neighborhood
string | null
​
state
string | null
​
city
string | null
​
hr_code
string | null
​
client_integration_code
string | null