Skip to main content
๐ŸŽ‰ API version '2024-10-01' just released with many new features. If you are still on an older version, check the migration guide.

Update a Dot Phrase

PATCH 

/dot-phrases/:id

Update a Dot Phrase.

Requestโ€‹

Path Parameters

    id uuidrequired

    The unique identifier of the Dot Phrase.

    Example: 23A9981B-9E46-4ADB-BB0B-8E406C624540

Body

required
    title string

    A user-friendly title for the Dot Phrase. Does not impact the matching logic.

    trigger string

    The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

    content_auto_update_enabled boolean

    If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

    replacement string

    The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Responsesโ€‹

The updated Dot Phrase.

Schema
    id uuidrequired

    Unique identifier of the Dot Phrase.

    title stringrequired

    A user-friendly title for the Dot Phrase. Does not impact the matching logic.

    trigger stringrequired

    The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

    content_auto_update_enabled booleanrequired

    If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

    replacement stringrequired

    The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Loading...