Skip to main content
PUT
/
api
/
v1
/
ops
/
organization
/
address
Define Organization Address
curl --request PUT \
  --url https://api.example.com/api/v1/ops/organization/address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "São Paulo",
  "country": "BR",
  "neighborhood": "Bela Vista",
  "number": "1000",
  "state": "SP",
  "street": "Av. Paulista",
  "zipCode": "01310-100",
  "complement": "Sala 42"
}
'
import requests

url = "https://api.example.com/api/v1/ops/organization/address"

payload = {
"city": "São Paulo",
"country": "BR",
"neighborhood": "Bela Vista",
"number": "1000",
"state": "SP",
"street": "Av. Paulista",
"zipCode": "01310-100",
"complement": "Sala 42"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
city: 'São Paulo',
country: 'BR',
neighborhood: 'Bela Vista',
number: '1000',
state: 'SP',
street: 'Av. Paulista',
zipCode: '01310-100',
complement: 'Sala 42'
})
};

fetch('https://api.example.com/api/v1/ops/organization/address', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/organization/address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'city' => 'São Paulo',
'country' => 'BR',
'neighborhood' => 'Bela Vista',
'number' => '1000',
'state' => 'SP',
'street' => 'Av. Paulista',
'zipCode' => '01310-100',
'complement' => 'Sala 42'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/ops/organization/address"

payload := strings.NewReader("{\n \"city\": \"São Paulo\",\n \"country\": \"BR\",\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Sala 42\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/ops/organization/address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"city\": \"São Paulo\",\n \"country\": \"BR\",\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Sala 42\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/ops/organization/address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"city\": \"São Paulo\",\n \"country\": \"BR\",\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Sala 42\"\n}"

response = http.request(request)
puts response.read_body
{
  "organizationAddressId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "country": "BR",
  "state": "SP",
  "city": "São Paulo",
  "zipCode": "01310-100",
  "street": "Av. Paulista",
  "neighborhood": "Bela Vista",
  "number": "1000",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "complement": "Sala 42",
  "createdBy": null,
  "updatedBy": null,
  "deletedBy": null,
  "deletedAt": null
}
{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}
{
"message": "Missing or invalid access token",
"statusCode": 401
}
{
"message": "Insufficient permissions",
"statusCode": 403
}
{
"message": "Internal Server Error",
"statusCode": 500
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

city
string
required

City

Example:

"São Paulo"

country
string
required

Country

Example:

"BR"

neighborhood
string
required

Neighborhood

Example:

"Bela Vista"

number
string
required

Number

Example:

"1000"

state
string
required

State

Example:

"SP"

street
string
required

Street

Example:

"Av. Paulista"

zipCode
string
required

Zip code

Example:

"01310-100"

complement
string | null

Complement

Example:

"Sala 42"

Response

OK

Organization address

organizationAddressId
string<uuid>
required

Address identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

country
any
required

Country

Example:

"BR"

state
any
required

State

Example:

"SP"

city
string
required

City

Example:

"São Paulo"

zipCode
any
required

Zip code

Example:

"01310-100"

street
string
required

Street

Example:

"Av. Paulista"

neighborhood
string
required

Neighborhood

Example:

"Bela Vista"

number
string
required

Number

Example:

"1000"

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

complement
string | null

Complement

Example:

"Sala 42"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null