Update organization information

curl --request PUT \
  --url https://api.example.com/api/organization \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "name": "Acme Inc.",
  "industry": "Technology",
  "location": "US",
  "baseCurrency": "USD",
  "timezone": "America/New_York",
  "fiscalYear": "January",
  "language": "en-US",
  "dateFormat": "MM/DD/YYYY",
  "address": {
    "address_1": "123 Main St",
    "address_2": "Suite 100",
    "postal_code": "10001",
    "city": "New York",
    "stateProvince": "NY",
    "phone": "+1-555-123-4567"
  },
  "primaryColor": "#4285F4",
  "logoKey": "organizations/acme-logo-123456.png",
  "taxNumber": "12-3456789"
}
'

import requests

url = "https://api.example.com/api/organization"

payload = {
    "name": "Acme Inc.",
    "industry": "Technology",
    "location": "US",
    "baseCurrency": "USD",
    "timezone": "America/New_York",
    "fiscalYear": "January",
    "language": "en-US",
    "dateFormat": "MM/DD/YYYY",
    "address": {
        "address_1": "123 Main St",
        "address_2": "Suite 100",
        "postal_code": "10001",
        "city": "New York",
        "stateProvince": "NY",
        "phone": "+1-555-123-4567"
    },
    "primaryColor": "#4285F4",
    "logoKey": "organizations/acme-logo-123456.png",
    "taxNumber": "12-3456789"
}
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: 'Acme Inc.',
    industry: 'Technology',
    location: 'US',
    baseCurrency: 'USD',
    timezone: 'America/New_York',
    fiscalYear: 'January',
    language: 'en-US',
    dateFormat: 'MM/DD/YYYY',
    address: {
      address_1: '123 Main St',
      address_2: 'Suite 100',
      postal_code: '10001',
      city: 'New York',
      stateProvince: 'NY',
      phone: '+1-555-123-4567'
    },
    primaryColor: '#4285F4',
    logoKey: 'organizations/acme-logo-123456.png',
    taxNumber: '12-3456789'
  })
};

fetch('https://api.example.com/api/organization', 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/organization",
  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' => 'Acme Inc.',
    'industry' => 'Technology',
    'location' => 'US',
    'baseCurrency' => 'USD',
    'timezone' => 'America/New_York',
    'fiscalYear' => 'January',
    'language' => 'en-US',
    'dateFormat' => 'MM/DD/YYYY',
    'address' => [
        'address_1' => '123 Main St',
        'address_2' => 'Suite 100',
        'postal_code' => '10001',
        'city' => 'New York',
        'stateProvince' => 'NY',
        'phone' => '+1-555-123-4567'
    ],
    'primaryColor' => '#4285F4',
    'logoKey' => 'organizations/acme-logo-123456.png',
    'taxNumber' => '12-3456789'
  ]),
  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/organization"

	payload := strings.NewReader("{\n  \"name\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\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/organization")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\n}"

response = http.request(request)
puts response.read_body

PUT

api

organization

Update organization information

curl --request PUT \
  --url https://api.example.com/api/organization \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "name": "Acme Inc.",
  "industry": "Technology",
  "location": "US",
  "baseCurrency": "USD",
  "timezone": "America/New_York",
  "fiscalYear": "January",
  "language": "en-US",
  "dateFormat": "MM/DD/YYYY",
  "address": {
    "address_1": "123 Main St",
    "address_2": "Suite 100",
    "postal_code": "10001",
    "city": "New York",
    "stateProvince": "NY",
    "phone": "+1-555-123-4567"
  },
  "primaryColor": "#4285F4",
  "logoKey": "organizations/acme-logo-123456.png",
  "taxNumber": "12-3456789"
}
'

import requests

url = "https://api.example.com/api/organization"

payload = {
    "name": "Acme Inc.",
    "industry": "Technology",
    "location": "US",
    "baseCurrency": "USD",
    "timezone": "America/New_York",
    "fiscalYear": "January",
    "language": "en-US",
    "dateFormat": "MM/DD/YYYY",
    "address": {
        "address_1": "123 Main St",
        "address_2": "Suite 100",
        "postal_code": "10001",
        "city": "New York",
        "stateProvince": "NY",
        "phone": "+1-555-123-4567"
    },
    "primaryColor": "#4285F4",
    "logoKey": "organizations/acme-logo-123456.png",
    "taxNumber": "12-3456789"
}
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: 'Acme Inc.',
    industry: 'Technology',
    location: 'US',
    baseCurrency: 'USD',
    timezone: 'America/New_York',
    fiscalYear: 'January',
    language: 'en-US',
    dateFormat: 'MM/DD/YYYY',
    address: {
      address_1: '123 Main St',
      address_2: 'Suite 100',
      postal_code: '10001',
      city: 'New York',
      stateProvince: 'NY',
      phone: '+1-555-123-4567'
    },
    primaryColor: '#4285F4',
    logoKey: 'organizations/acme-logo-123456.png',
    taxNumber: '12-3456789'
  })
};

fetch('https://api.example.com/api/organization', 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/organization",
  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' => 'Acme Inc.',
    'industry' => 'Technology',
    'location' => 'US',
    'baseCurrency' => 'USD',
    'timezone' => 'America/New_York',
    'fiscalYear' => 'January',
    'language' => 'en-US',
    'dateFormat' => 'MM/DD/YYYY',
    'address' => [
        'address_1' => '123 Main St',
        'address_2' => 'Suite 100',
        'postal_code' => '10001',
        'city' => 'New York',
        'stateProvince' => 'NY',
        'phone' => '+1-555-123-4567'
    ],
    'primaryColor' => '#4285F4',
    'logoKey' => 'organizations/acme-logo-123456.png',
    'taxNumber' => '12-3456789'
  ]),
  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/organization"

	payload := strings.NewReader("{\n  \"name\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\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/organization")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Acme Inc.\",\n  \"industry\": \"Technology\",\n  \"location\": \"US\",\n  \"baseCurrency\": \"USD\",\n  \"timezone\": \"America/New_York\",\n  \"fiscalYear\": \"January\",\n  \"language\": \"en-US\",\n  \"dateFormat\": \"MM/DD/YYYY\",\n  \"address\": {\n    \"address_1\": \"123 Main St\",\n    \"address_2\": \"Suite 100\",\n    \"postal_code\": \"10001\",\n    \"city\": \"New York\",\n    \"stateProvince\": \"NY\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"primaryColor\": \"#4285F4\",\n  \"logoKey\": \"organizations/acme-logo-123456.png\",\n  \"taxNumber\": \"12-3456789\"\n}"

response = http.request(request)
puts response.read_body

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json

name

string

Organization name

Example:

"Acme Inc."

industry

string

Industry of the organization

Example:

"Technology"

location

string

Country location in ISO 3166-1 alpha-2 format

Example:

"US"

baseCurrency

string

Base currency in ISO 4217 format

Example:

"USD"

timezone

string

Timezone of the organization

Example:

"America/New_York"

fiscalYear

string

Starting month of fiscal year

Example:

"January"

language

string

Language/locale of the organization

Example:

"en-US"

dateFormat

string

Date format used by the organization

Example:

"MM/DD/YYYY"

address

object

Organization address details

Example:

{
  "address_1": "123 Main St",
  "address_2": "Suite 100",
  "postal_code": "10001",
  "city": "New York",
  "stateProvince": "NY",
  "phone": "+1-555-123-4567"
}

primaryColor

string

Primary brand color in hex format

Example:

"#4285F4"

logoKey

string

Logo file key reference

Example:

"organizations/acme-logo-123456.png"

taxNumber

string

Organization tax identification number

Example:

"12-3456789"

Response

200

Organization information has been updated successfully

Get apiorganizationbase currency mutate Get apipayment services

Get Started

API Reference

Update organization information

Headers

Body

Response