API Reference
API Reference

Update Current Organization

Update the current organization.

PUT/api/v1/organizations/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

multipart/form-data

body Body_organizations_update required
6 fields
logostring (binary) | nulloptional

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_namestringrequired

The human-readable display name of the organization

descriptionstring | nulloptional

Description of the organization

domainsstring | nulloptional

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

saml_provider_idstring | nulloptional

SAML provider ID for user authentication

update_commentsstring | nulloptional

Comments about the update

Request example
{
  "logo": "string",
  "display_name": "string",
  "description": "string",
  "domains": "string",
  "saml_provider_id": "string",
  "update_comments": "string"
}

Responses

200Successful Response

application/json

response OrganizationResponse required
11 fields
display_namestringrequired

The human-readable display name of the organization.

descriptionstring | nulloptional

Description of the organization.

domainsstring | nulloptional

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

saml_provider_idstring | nulloptional

SAML provider ID for user authentication

idintegerrequired

The internal ID of the organization.

last_updated_commentsstring | nulloptional

Comments for the most recent edit to the organization.

namestringrequired

Unique, non-human-readable hash for the organization

slugstring | nulloptional

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 | nulloptional

The email of the user who most recently updated the organization

logo_urlstring | nulloptional

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

Response example
{
  "display_name": "string",
  "description": "string",
  "domains": "string",
  "saml_provider_id": "string",
  "id": 0,
  "last_updated_comments": "string",
  "name": "string",
  "slug": "string",
  "last_updated": "string",
  "last_updated_by": "string",
  "logo_url": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}