PATCH
/
orgs
Update an organization
curl --request PATCH \
  --url https://app.happyrobot.ai/api/v1/orgs \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "id": "<string>",
  "name": "Happyrobot",
  "description": "A company that builds AI assistants.",
  "api_key": "<string>",
  "image_url": "<string>",
  "members": [
    {
      "email": "jsmith@example.com",
      "role": "Representative"
    }
  ],
  "twilio_credentials": {
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "your_auth_token",
    "api_key_id": "SKXXXXXXXXXXXXXXXXXXXXXXXX",
    "api_key_secret": "your_api_key_secret"
  },
  "attributes": [
    "Logistics",
    "Warehousing"
  ]
}'
{
  "id": "<string>",
  "name": "Happyrobot",
  "description": "A company that builds AI assistants.",
  "api_key": "<string>",
  "image_url": "<string>",
  "members": [
    {
      "email": "jsmith@example.com",
      "role": "Representative"
    }
  ],
  "twilio_credentials": {
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "your_auth_token",
    "api_key_id": "SKXXXXXXXXXXXXXXXXXXXXXXXX",
    "api_key_secret": "your_api_key_secret"
  },
  "attributes": [
    "Logistics",
    "Warehousing"
  ]
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Body

application/json

Body

​
id
string
required

The organization's unique identifier.

​
name
string
required

The organization's name.

Required string length: 2 - 30
Example:

"Happyrobot"

​
api_key
string
required

The organization's API key.

​
members
object[]
required

The organization's members.

​
description
string

The organization's description.

Example:

"A company that builds AI assistants."

​
image_url
string

The organization's logo. Can be a URL or a base64 encoded image.

​
twilio_credentials
object

The organization's Twilio credentials.

​
attributes
string[]

The organization's attributes.

Example:
["Logistics", "Warehousing"]

Response

200

​
id
string
required

The organization's unique identifier.

​
name
string
required

The organization's name.

Required string length: 2 - 30
Example:

"Happyrobot"

​
api_key
string
required

The organization's API key.

​
members
object[]
required

The organization's members.

​
description
string

The organization's description.

Example:

"A company that builds AI assistants."

​
image_url
string

The organization's logo. Can be a URL or a base64 encoded image.

​
twilio_credentials
object

The organization's Twilio credentials.

​
attributes
string[]

The organization's attributes.

Example:
["Logistics", "Warehousing"]