Skip to main content
PATCH
/
organizations
/
{orgId}
Update an organization
curl --request PATCH \
  --url https://api.blurb.fail/v1/organizations/{orgId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgId": "1234567890",
  "authToken": "1234567890",
  "name": "My Org",
  "webhookUrl": "https://example.com/webhook",
  "logoUrl": "https://example.com/logo.png",
  "createdAt": {
    "seconds": 123,
    "nanoseconds": 123
  },
  "updatedAt": {
    "seconds": 123,
    "nanoseconds": 123
  }
}
'
{
  "success": true,
  "message": "Organization updated",
  "data": {
    "orgId": "example",
    "authToken": "example",
    "name": "example",
    "webhookUrl": null,
    "logoUrl": null,
    "createdAt": {
      "seconds": 3,
      "nanoseconds": 3
    },
    "updatedAt": {
      "seconds": 3,
      "nanoseconds": 3
    }
  }
}

Path Parameters

​
orgId
string
required
Example:

"my-org-id"

Body

application/json

The request to update an organization.

​
orgId
string
required

The ID of the organization

Example:

"1234567890"

​
authToken
string
required

The authentication token for the organization

Example:

"1234567890"

​
name
string
required

The name of the organization

Example:

"My Org"

​
webhookUrl
string | null
required

The webhook URL for the organization

Example:

"https://example.com/webhook"

​
logoUrl
string | null
required

The logo URL for the organization

Example:

"https://example.com/logo.png"

​
createdAt
required

A timestamp value that can be stored in Firestore

​
updatedAt
required

A timestamp value that can be stored in Firestore

Response

Organization updated successfully

​
success
boolean
required

Whether the request was successful

Example:

true

​
message
string | null
required

Message from the API

Example:

"Organization updated"

​
data
object
required

The response from the Organization PATCH request.

Example:
{
  "orgId": "example",
  "authToken": "example",
  "name": "example",
  "webhookUrl": null,
  "logoUrl": null,
  "createdAt": { "seconds": 3, "nanoseconds": 3 },
  "updatedAt": { "seconds": 3, "nanoseconds": 3 }
}