Skip to main content
PATCH
Update goal

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Goal ID

Body

application/json
title
string

Goal title

Required string length: 1 - 200
description
string | null

Goal description

Maximum string length: 5000
companyId
string<uuid>

Company ID

statusId
string<uuid> | null

Status ID (null to clear)

priorityId
string<uuid> | null

Priority ID (null to clear)

categoryId
string<uuid> | null

Category ID (null to clear)

dueDate
string<date-time> | null

Due date (null to clear)

progressPercentage
number

Progress (0-100)

Required range: 0 <= x <= 100
quarter
string | null

Quarter (null to clear)

Maximum string length: 2
year
number | null

Year (null to clear)

Required range: 2000 <= x <= 2100

Response

Goal updated successfully

data
object
required