AMamigo
Organization

Modify an organization

Modify elements of an organization.

Permissions

This endpoint requries the following permissions:

  • Organization:ModifyOrganization to modify the organization.
post/v1/{organization}/organization/

Request

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

logostring base64 nullable

A logo for the organization that will be displayed on the Amigo frontend for this organization, as well as all Amigo communications to users on behalf of the organization. Must be provided as base64 encoded bytes of a PNG image of aspect ratio 5:2 with minimum size 400 * 160 pixels. Only updated if not null.

square_logostring base64 nullable

A square logo of the organization. Must be provided as base64 encoded bytes of a square PNG image of size at least 40 * 40 pixels. Only updated if not null.

faviconstring base64 nullable

Favicon for the Amigo frontend for this organization. Must be provided as base64 encoded bytes of a square ICO image that's of size at least 40 * 40 pixels. Only updated if not null.

Response

Succeeded.

Changes

No operation changes recorded.