Skip to main content
PATCH
/
organizations
/
{slug}
/
cURL
curl --request PATCH \
  --url https://api.avala.ai/api/v1/organizations/{slug}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Avala-Api-Key: <api-key>' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "website": "<string>",
  "handle": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>"
}
'
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "logo": "<string>",
  "website": "<string>",
  "handle": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>"
}

Authorizations

​
X-Avala-Api-Key
string
header
required

API key for authentication. Generate one in Mission Control Settings > Security & Identity.

Path Parameters

​
slug
string
required

Body

application/json
​
slug
string<slug>
Required string length: 1 - 255
Pattern: ^[-a-zA-Z0-9_]+$
​
name
string
Required string length: 1 - 1024
​
description
string
Maximum string length: 1024
​
website
string<uri>
Maximum string length: 200
​
handle
string | null

Unique handle for the organization (e.g., 'irobot'). Used in URLs and mentions.

Maximum string length: 50
Pattern: ^[a-zA-Z0-9_]+$
​
industry
enum<string>
Available options:
robotics,
autonomous_vehicle,
ai_ml,
other
​
email
string<email>

Contact email for the organization.

Maximum string length: 254
​
phone
string

Contact phone number for the organization.

Maximum string length: 50
​
visibility
enum<string>

Whether the organization profile is publicly visible.

Available options:
public,
private

Response

200 - application/json
​
slug
string<slug>
Required string length: 1 - 255
Pattern: ^[-a-zA-Z0-9_]+$
​
name
string
Required string length: 1 - 1024
​
description
string
Maximum string length: 1024
​
logo
string<uri> | null
read-only
​
website
string<uri>
Maximum string length: 200
​
handle
string | null

Unique handle for the organization (e.g., 'irobot'). Used in URLs and mentions.

Maximum string length: 50
Pattern: ^[a-zA-Z0-9_]+$
​
industry
enum<string>
Available options:
robotics,
autonomous_vehicle,
ai_ml,
other
​
email
string<email>

Contact email for the organization.

Maximum string length: 254
​
phone
string

Contact phone number for the organization.

Maximum string length: 50
​
visibility
enum<string>

Whether the organization profile is publicly visible.

Available options:
public,
private