Update a satisfaction goal

curl --request PATCH \
  --url https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "name": "Raise CSAT to 85%",
    "metric": "csat",
    "target": 85,
    "survey_id": null,
    "window_days": 30,
    "enabled": true,
    "baseline": 71.2,
    "created_at": "2026-08-01T10:00:00.000Z",
    "updated_at": "2026-08-19T12:00:00.000Z",
    "metric_label": "CSAT",
    "unit": "percent",
    "progress": {
      "current": 78.4,
      "target": 85,
      "baseline": 71.2,
      "unit": "percent",
      "progress_pct": 52.2,
      "attained": false,
      "remaining": 6.6,
      "sample_size": 412
    }
  },
  "meta": {
    "request_id": "req_01J9Z8ABCDEF",
    "timestamp": "2026-08-15T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Analytics

Update a satisfaction goal

Patches a satisfaction goal — name, target, survey_id, window_days and enabled are all optional but at least one must be provided. metric is immutable: a goal’s metric fixes its scale and the baseline captured at creation, so changing it would silently invalidate stored progress. The new target is range-checked against the STORED metric; a (re)pointed survey_id must resolve to a live survey of the same type, exactly as on create. Returns 404 for an unknown id. Requires owner / admin / developer; returns the updated goal with live progress.

PATCH

api

analytics

satisfaction-goals

{id}

Update a satisfaction goal

curl --request PATCH \
  --url https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/analytics/satisfaction-goals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "name": "Raise CSAT to 85%",
    "metric": "csat",
    "target": 85,
    "survey_id": null,
    "window_days": 30,
    "enabled": true,
    "baseline": 71.2,
    "created_at": "2026-08-01T10:00:00.000Z",
    "updated_at": "2026-08-19T12:00:00.000Z",
    "metric_label": "CSAT",
    "unit": "percent",
    "progress": {
      "current": 78.4,
      "target": 85,
      "baseline": 71.2,
      "unit": "percent",
      "progress_pct": 52.2,
      "attained": false,
      "remaining": 6.6,
      "sample_size": 412
    }
  },
  "meta": {
    "request_id": "req_01J9Z8ABCDEF",
    "timestamp": "2026-08-15T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Dashboard JWT token from Clerk

Headers

X-Test-Mode

enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:

true,

false

Path Parameters

string

required

Response

Standard { data, meta } envelope. The updated satisfaction goal with its live progress block.

data

object

The updated satisfaction goal with its live progress block.

Example:

{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "name": "Raise CSAT to 85%",
  "metric": "csat",
  "target": 85,
  "survey_id": null,
  "window_days": 30,
  "enabled": true,
  "baseline": 71.2,
  "created_at": "2026-08-01T10:00:00.000Z",
  "updated_at": "2026-08-19T12:00:00.000Z",
  "metric_label": "CSAT",
  "unit": "percent",
  "progress": {
    "current": 78.4,
    "target": 85,
    "baseline": 71.2,
    "unit": "percent",
    "progress_pct": 52.2,
    "attained": false,
    "remaining": 6.6,
    "sample_size": 412
  }
}

API Reference

All Endpoints

Update a satisfaction goal

Authorizations

Headers

Path Parameters

Response