Skip to main content
PATCH
/
organizations
/
{orgId}
Update organization
curl --request PATCH \
  --url https://api.helloannie.com/v1/organizations/{orgId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "phone": "<string>",
  "referenceId": "<string>",
  "address": {
    "addressLine1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "addressLine2": "<string>"
  }
}
'
import requests

url = "https://api.helloannie.com/v1/organizations/{orgId}"

payload = {
"name": "<string>",
"phone": "<string>",
"referenceId": "<string>",
"address": {
"addressLine1": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zip": "<string>",
"addressLine2": "<string>"
}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
phone: '<string>',
referenceId: '<string>',
address: {
addressLine1: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
zip: '<string>',
addressLine2: '<string>'
}
})
};

fetch('https://api.helloannie.com/v1/organizations/{orgId}', 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.helloannie.com/v1/organizations/{orgId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'phone' => '<string>',
'referenceId' => '<string>',
'address' => [
'addressLine1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'zip' => '<string>',
'addressLine2' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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.helloannie.com/v1/organizations/{orgId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"address\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"addressLine2\": \"<string>\"\n }\n}")

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

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.patch("https://api.helloannie.com/v1/organizations/{orgId}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"address\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"addressLine2\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helloannie.com/v1/organizations/{orgId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"address\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"addressLine2\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "enabled": true,
    "phone": "<string>",
    "referenceId": "<string>",
    "parentAccountOrgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": {
      "addressLine1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zip": "<string>",
      "addressLine2": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"success": false,
"data": {},
"message": "<string>"
}
{
"success": false,
"data": {},
"message": "<string>"
}

Path Parameters

orgId
string<uuid>
required

The ID of the organization to update

Body

Fields that can be updated on an existing organization

name
string

Organization name

timezone
enum<string>
Available options:
America/New_York,
America/Chicago,
America/Denver,
America/Phoenix,
America/Los_Angeles,
America/Anchorage,
Pacific/Honolulu,
America/Toronto,
America/Vancouver,
America/Edmonton,
America/Winnipeg,
America/Halifax,
America/St_Johns,
America/Mexico_City
phone
string

Organization phone number

referenceId
string | null

Customer-provided identifier that maps to an entity in their system

Maximum string length: 255
address
object | null

Address fields for creating an organization

Response

Response returned after updating an organization

success
enum<boolean>
required
Available options:
true
data
object
required

Represents an organization and its configuration