API Reference

update goal

patch
https://{defaultHost}/goals/

Update an existing goal by its UUID. You can update any combination of fields including name, aliases, description, tags, and archived status. Only the fields you provide will be updated (partial updates are supported).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier (UUID) of the goal. This is returned in the id field when you create or retrieve a goal.

Body Params

The updated goal data

Request body for creating or updating a Fact Card. Fact Cards are the core entities in Colloquial, representing business concepts like applications, services, capabilities, and more.

When creating a Fact Card, only the name field is required. All other fields are optional and can be added or updated later.

When updating a Fact Card, only include the fields you want to change. Partial updates are supported - you don't need to send all fields.

string
required
length between 1 and 255

The primary name of the Fact Card. This is a required field and must be unique within your workspace.

string | null

Alternative names or aliases for the Fact Card, separated by commas. Useful for handling different naming conventions or abbreviations.

string | null

A detailed description of the Fact Card. Provides context and additional information about what this entity represents.

tag_ids
array of integers

An array of tag IDs to associate with this Fact Card. Tags help categorise and organise your Fact Cards for easier discovery and filtering.

tag_ids
boolean
Defaults to false

Controls the archived status of the Fact Card. Set to true to archive it, false to restore it, or omit the field to leave the status unchanged.

Responses

Updated 12 days ago

Language
Credentials
Bearer
Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago