Skip to main content
PUT
Update Guidance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the guidance.

Body

application/json
name
string

Short title identifying this Help Desk Skill (e.g. "Route password reset tickets to IT").

description
string

TRIGGER condition — when should the help desk agent invoke this skill? Plain prose answering "When should Serval use this skill?". Example: "When a ticket is about an SSO login failure or a user cannot access their Okta account."

content
string

BEHAVIOR instructions — how should the help desk agent handle the situation when this skill fires? Plain prose answering "How should Serval handle this situation?". Include the concrete steps, workflows to run (use <@workflow:ID> mentions), who to escalate to (use <@user:ID> mentions), and any relevant context.

shouldAlwaysUse
boolean | null

Whether this guidance should always be used (optional).

isPublished
boolean | null

Whether the guidance is published. Set to true to publish the guidance.

Response

Success

data
data · object

The updated guidance.