PUT /v1/rooms/:id

The PUT /v1/rooms/:id endpoint allows you to update information of the specified room associated with your account.

HTTP Method

PUT

URL

https://api.nomi.ai/v1/rooms/:id

URL Parameters

{
  id: UUID;
}

Response Body Format

{
  name?: string; // 100 characters max
  note?: string; // 1,000 characters max
  nomiUuids?: Array<UUID>; // min 1 nomi, max 10 nomis
  backchannelingEnabled?: boolean;
}

Response Body Format

{
  uuid: UUID;
  name: string;
  created: ISODateString;
  updated: ISODateString;
  status: "Creating" | "Default" | "Waiting" | "Typing" | "Error" | "InitialNoteError" | "Manual" | "TranscriptionError";
  backchannelingEnabled: boolean;
  nomis: Array<{
    uuid: UUID;
    gender: "Male" | "Female" | "Non Binary";
    name: string;
    created: ISODateString;
    relationshipType: "Mentor" | "Friend" | "Romantic";
  }>;
  note: string;
}

Error Response Types

Type	Description
RoomNotFound	The specified room was not found. It may not exist or may not be associated with this account.
InvalidRouteParams	The id parameter is not a valid UUID.
InvalidContentType	The Content-Type header is not application/json.
RoomNomiCountTooSmall	If nomiUuids is set, it should contain at least 1 valid UUID from Nomis associated with this account.
RoomNomiCountTooLarge	If nomiUuids is set, it should contain at most 10 valid UUID from Nomis associated with this account.
NoteNotAccepted	There was an issue with your room note and we could not update your room. Please revise the note and try again.
NoResponseFromServer	The server did not respond to the note update request. This is rare but will occur if there is a server issue or if the server does not respond within 20 seconds.
InvalidBody	Issue will be detailed in the errors.issues key, but there is an issue with the request body. This can happen if none of the optional keys exists, type error, character limit, or nomiUuids does not contain exact one valid UUID.