Skip to content
Navigation
PATCH/roadmaps/{roadmapId}

Update a roadmap

Update an existing roadmap

Parameters

NameInTypeDescription
roadmapIdrequiredpathstringRoadmap ID

Request body

FieldTypeDescription
namestring
descriptionstring | null
type"column" | "date"
baseFilterobject
dateSource"eta" | null
frequency"monthly" | "quarterly" | "semiannual" | null
visibility"public" | "team" | "segment"
isPublicbooleanDeprecated: use `visibility`. `false` maps to `team`, `true` maps to `public`. Ignored when `visibility` is sent.
visibleSegmentIdsstring[] | null
columnsobject[]

Response

Roadmap updated

FieldTypeDescription
idrequiredstringTypeID - a type-prefixed UUID
namerequiredstring
slugrequiredstringURL-friendly identifier
descriptionrequiredstringnull
typerequired"column" | "date"
baseFilterrequiredobject
dateSourcerequired"eta" | null
frequencyrequired"monthly" | "quarterly" | "semiannual" | null
visibilityrequired"public" | "team" | "segment"
visibleSegmentIdsrequiredstring[] | null
positionrequirednumberDisplay order
columnsrequiredobject[]
createdAtrequiredstringISO 8601 timestamp

Errors

400Validation error
401Unauthorized
404Roadmap not found

Example request

curl \
  -X PATCH \
  "https://feedback.quackback.io/api/v1/roadmaps/:roadmapId" \
  -H "Authorization: Bearer qb_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example_name",
  "type": "example_type",
  "visibility": "example_visibility",
  "isPublic": false,
  "columns": []
}'