ASasksyllable
organizations

Update Current Organization

Changed on

Update the current organization.

put/api/v1/organizations/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/organizations/
  • Auth
    API key in header Syllable-API-Key

Request body multipart/form-data

logostring binary nullable

The organization logo image file to upload. Must be a PNG file and 120x120 pixels. If not provided, the logo will not be updated.

display_namestring required

The human-readable display name of the organization

descriptionstring nullable

Description of the organization

domainsstring nullable

Comma-delimited list of domains that users at the organization may have in their email addresses

saml_provider_idstring nullable

SAML provider ID for user authentication

update_commentsstring nullable

Comments about the update

Example request

{
  "display_name": "My Great Org",
  "description": "An organization that does great things with agentic AI",
  "domains": "mygreatorg.com,mygreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "update_comments": "Updated the organization to add a new domain"
}

Response

Successful Response

display_namestring required

The human-readable display name of the organization.

descriptionstring nullable

Description of the organization.

domainsstring nullable

Comma-delimited list of domains that users at the organization may have in their email addresses.

saml_provider_idstring nullable

SAML provider ID for user authentication

idinteger required

The internal ID of the organization.

last_updated_commentsstring nullable

Comments for the most recent edit to the organization.

namestring required

Unique, non-human-readable hash for the organization

slugstring nullable

The slug of the organization used for URLs in the Console UI. Null until slug backfill has been run.

last_updatedstring date-time required

The timestamp of the most recent update to the organization

last_updated_bystring nullable

The email of the user who most recently updated the organization

logo_urlstring nullable

CDN URL. The org will always have a logo, but this value will be null on a response to an update where no logo was provided on the request

Example response

{
  "display_name": "My Great Org",
  "description": "An organization that does great things with agentic AI.",
  "domains": "mygreatorg.com,myothergreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "id": 1,
  "last_updated_comments": "Updated to add an additional domain",
  "slug": "my-great-org",
  "logo_url": "https://image.png"
}

Changes

  • efcd18177c46Revision changes
    • info

      added the required property to the response with the status

  • cf9d54bd559fRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property slug list-of-types was widened by adding types null to media type application/json of response 200