Skip to main content
PUT
/
api
/
v1
/
bko
/
organizations
/
{organizationId}
/
address
Define Organization Address
curl --request PUT \
  --url https://api.example.com/api/v1/bko/organizations/{organizationId}/address \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "<string>",
  "state": "<string>",
  "city": "<string>",
  "zipCode": "<string>",
  "street": "<string>",
  "neighborhood": "<string>",
  "number": "<string>",
  "complement": "<string>"
}
'
{
  "organizationAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "country": "<string>",
  "state": "<string>",
  "city": "<string>",
  "zipCode": "<string>",
  "street": "<string>",
  "neighborhood": "<string>",
  "number": "<string>",
  "complement": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
organizationId
string<uuid>
required

Organization identifier

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Define organization address payload

​
country
string
required

Country

​
state
string
required

State

​
city
string
required

City

​
zipCode
string
required

Zip code

​
street
string
required

Street

​
neighborhood
string
required

Neighborhood

​
number
string
required

Number

​
complement
string | null

Complement

Response

OK

Endereço da organização

​
organizationAddressId
string<uuid>
required

Identificador único

​
organizationId
string<uuid>
required

Referência à organização

​
country
string
required

País

​
state
string
required

Estado

​
city
string
required

Cidade

​
zipCode
string
required

CEP

​
street
string
required

Logradouro

​
neighborhood
string
required

Bairro

​
number
string
required

Número

​
complement
string | null
required

Complemento

​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização