curl --request PUT \
--url https://api.example.com/api/branches/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "Main Branch",
"primary": true,
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phone_number": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch"
}
'import requests
url = "https://api.example.com/api/branches/{id}"
payload = {
"name": "Main Branch",
"primary": True,
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phone_number": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Main Branch',
primary: true,
code: 'BR001',
address: '123 Main Street',
city: 'New York',
country: 'USA',
phone_number: '+1-555-123-4567',
email: '[email protected]',
website: 'https://www.example.com/branch'
})
};
fetch('https://api.example.com/api/branches/{id}', 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/branches/{id}",
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([
'name' => 'Main Branch',
'primary' => true,
'code' => 'BR001',
'address' => '123 Main Street',
'city' => 'New York',
'country' => 'USA',
'phone_number' => '+1-555-123-4567',
'email' => '[email protected]',
'website' => 'https://www.example.com/branch'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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/branches/{id}"
payload := strings.NewReader("{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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/branches/{id}")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/branches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Main Branch",
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phoneNumber": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch",
"primary": true,
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z"
}Edit the given branch.
curl --request PUT \
--url https://api.example.com/api/branches/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "Main Branch",
"primary": true,
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phone_number": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch"
}
'import requests
url = "https://api.example.com/api/branches/{id}"
payload = {
"name": "Main Branch",
"primary": True,
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phone_number": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Main Branch',
primary: true,
code: 'BR001',
address: '123 Main Street',
city: 'New York',
country: 'USA',
phone_number: '+1-555-123-4567',
email: '[email protected]',
website: 'https://www.example.com/branch'
})
};
fetch('https://api.example.com/api/branches/{id}', 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/branches/{id}",
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([
'name' => 'Main Branch',
'primary' => true,
'code' => 'BR001',
'address' => '123 Main Street',
'city' => 'New York',
'country' => 'USA',
'phone_number' => '+1-555-123-4567',
'email' => '[email protected]',
'website' => 'https://www.example.com/branch'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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/branches/{id}"
payload := strings.NewReader("{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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/branches/{id}")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/branches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Main Branch\",\n \"primary\": true,\n \"code\": \"BR001\",\n \"address\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"[email protected]\",\n \"website\": \"https://www.example.com/branch\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Main Branch",
"code": "BR001",
"address": "123 Main Street",
"city": "New York",
"country": "USA",
"phoneNumber": "+1-555-123-4567",
"email": "[email protected]",
"website": "https://www.example.com/branch",
"primary": true,
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z"
}Headers
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Path Parameters
Body
Branch name
"Main Branch"
Whether this is the primary branch
true
Branch code
"BR001"
Branch address
"123 Main Street"
Branch city
"New York"
Branch country
"USA"
Branch phone number
"+1-555-123-4567"
Branch email
Branch website
"https://www.example.com/branch"
Response
The branch has been successfully edited.
Branch ID
1
Branch name
"Main Branch"
Branch code
"BR001"
Branch address
"123 Main Street"
Branch city
"New York"
Branch country
"USA"
Branch phone number
"+1-555-123-4567"
Branch email
Branch website
"https://www.example.com/branch"
Whether this is the primary branch
true
Creation timestamp
"2024-03-20T10:00:00Z"
Last update timestamp
"2024-03-20T10:00:00Z"