Create Guidance - Serval Documentation

POST

guidances

Create Guidance

curl --request POST \
  --url https://public.api.serval.com/v2/guidances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "content": "<string>",
  "description": "<string>",
  "shouldAlwaysUse": true,
  "isPublished": true
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": true,
    "isPublished": true,
    "hasUnpublishedChanges": true
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string

required

The ID of the team.

name

string

required

The name of the guidance.

content

string

required

The content of the guidance.

description

string

A description of the guidance.

shouldAlwaysUse

boolean | null

Whether this guidance should always be used (optional, defaults to false).

isPublished

boolean | null

Whether to publish the guidance after creation (optional).

Response

Success

data

data · object

The created guidance.

Show child attributes

Create Guidance

curl --request POST \
  --url https://public.api.serval.com/v2/guidances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "content": "<string>",
  "description": "<string>",
  "shouldAlwaysUse": true,
  "isPublished": true
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": true,
    "isPublished": true,
    "hasUnpublishedChanges": true
  }
}