Skip to main content
PATCH
/
organizations
/
{id}
Update organization
curl --request PATCH \
  --url https://api.helloannie.com/v1/organizations/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "timezone": "America/New_York",
  "phone": "<string>",
  "referenceId": "<string>",
  "address": {
    "addressLine1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "addressLine2": "<string>"
  }
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "timezone": "America/New_York",
    "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"
  }
}

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/Toronto,
America/Vancouver,
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

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