Features Pricing API Docs Sign In Get Started

API Documentation

The Pathwayful API is easy to use and free for all plans.

Update Roadmap

Update an existing roadmap's name, slug, or description.

PATCH https://api.pathwayful.com/roadmaps/:id

Headers

  • AuthorizationREQUIRED STRING
    Bearer $TOKEN
  • Content-TypeREQUIRED STRING
    application/json

Request body

{
  "roadmap": {
    "name": "Updated Roadmap",
    "description": "Updated description"
  }
}

Response body

{
  "id": "uuid",
  "name": "Updated Roadmap",
  "slug": "product-roadmap",
  "description": "Updated description",
  "custom_domain": null,
  "domain_active": false,
  "created_at": "2024-01-01T00:00:00Z",
  "columns": [
    {
      "id": "uuid",
      "name": "Planned",
      "position": 0
    }
  ],
  "issues": [],
  "tags": [
    {
      "id": "uuid",
      "name": "Feature",
      "color": "#3B82F6"
    }
  ]
}

Code Examples

curl -X PATCH "https://api.pathwayful.com/roadmaps/your-roadmap-id" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "roadmap": {
      "name": "Updated Roadmap",
      "description": "Updated description"
    }
  }'
// Update a roadmap
const roadmapId = 'your-roadmap-id';
const response = await fetch(`https://api.pathwayful.com/roadmaps/${roadmapId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer ' + yourToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    roadmap: {
      name: 'Updated Roadmap',
      description: 'Updated description'
    }
  })
});

const roadmap = await response.json();
console.log('Updated roadmap:', roadmap);
# Update a roadmap
import requests

roadmap_id = 'your-roadmap-id'
headers = {
    'Authorization': f'Bearer {your_token}',
    'Content-Type': 'application/json'
}

data = {
    'roadmap': {
        'name': 'Updated Roadmap',
        'description': 'Updated description'
    }
}

response = requests.patch(
    f'https://api.pathwayful.com/roadmaps/{roadmap_id}',
    headers=headers,
    json=data
)

roadmap = response.json()
print(f"Updated roadmap: {roadmap}")
// Update a roadmap
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    roadmapID := "your-roadmap-id"
    data := map[string]interface{}{
        "roadmap": map[string]string{
            "name":        "Updated Roadmap",
            "description": "Updated description",
        },
    }
    jsonData, _ := json.Marshal(data)

    req, _ := http.NewRequest("PATCH", "https://api.pathwayful.com/roadmaps/"+roadmapID, bytes.NewBuffer(jsonData))
    req.Header.Set("Authorization", "Bearer "+yourToken)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var roadmap map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&roadmap)
    fmt.Printf("Updated roadmap: %v\n", roadmap)
}
# Update a roadmap
require 'net/http'
require 'json'
require 'uri'

roadmap_id = 'your-roadmap-id'
uri = URI("https://api.pathwayful.com/roadmaps/#{roadmap_id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Authorization'] = "Bearer #{your_token}"
request['Content-Type'] = 'application/json'
request.body = {
  roadmap: {
    name: 'Updated Roadmap',
    description: 'Updated description'
  }
}.to_json

response = http.request(request)
roadmap = JSON.parse(response.body)
puts "Updated roadmap: #{roadmap}"
<?php
// Update a roadmap
$roadmapId = 'your-roadmap-id';
$data = [
    'roadmap' => [
        'name' => 'Updated Roadmap',
        'description' => 'Updated description'
    ]
];

$ch = curl_init("https://api.pathwayful.com/roadmaps/{$roadmapId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $yourToken,
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

$response = curl_exec($ch);
curl_close($ch);

$roadmap = json_decode($response, true);
print_r($roadmap);