Skip to main content
PATCH
Update an action plan group

Authorizations

Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Path Parameters

id
string
required

MongoDB ObjectId of the action plan group.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

All fields optional; only the ones present are changed.

name
string
Maximum string length: 120
description
string

Empty string clears it.

Maximum string length: 500
conditions
object[]
Required array length: 1 - 20 elements
members
object[]
Minimum array length: 1
threshold
integer
Required range: x >= 1

Response

Group updated

_id
string
Example:

"507f1f77bcf86cd799439031"

companyId
string
name
string
description
string
conditions
object[]
members
object[]
threshold
integer
Example:

300

enabled
boolean
default:true

A disabled group stops counting feedback and generating drafts, but keeps its history and stats visible.

counterSince
string<date-time>

Base date of the negatives counter: only feedback created after it counts toward threshold.

createdAt
string<date-time>
updatedAt
string<date-time>