Skip to main content
PATCH
/
dtt
/
settings
/
{id}
curl --request PATCH \
  --url https://dashboard.researchanddesire.com/api/v1/dtt/settings/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Advanced Program"
}
'
{
  "ok": true,
  "data": {
    "id": 1,
    "bubbleId": "prog-001",
    "ownerId": 42,
    "name": "Advanced Program",
    "description": "A challenging program",
    "tagline": null,
    "message": "Well done!",
    "isPublic": true,
    "isActive": true,
    "handsFreeMode": false,
    "targetDepth": 75,
    "targetWindow": 20,
    "toyId": null,
    "createdDate": "2025-06-01T10:00:00Z",
    "updatedAt": "2026-02-23T10:30:00Z",
    "Segment": [
      {
        "id": 10,
        "type": "endurance",
        "duration": 300,
        "speed": 50,
        "repeat": 2
      },
      {
        "id": 11,
        "type": "freeform",
        "duration": 60,
        "speed": 80,
        "repeat": 1
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

API tokens can be created in the Dashboard settings. Requires an Ultra subscription.

Path Parameters

id
integer
required

The DTT settings (training program) ID

Required range: x >= 1
Example:

1

Body

application/json

All fields are optional. Only include the fields you want to change. If Segment is provided, it replaces the entire segment list.

name
string

Program name (4–128 characters, cannot be blank)

Required string length: 4 - 128
targetWindow
number

Target window size

targetDepth
number

Target depth percentage

toyId
integer | null

Associated toy ID (0 or null to unset)

message
string | null

Completion message (max 50 chars, defaults to "Good Work!")

Maximum string length: 50
handsFreeMode
boolean

Enable hands-free mode (Ultra only)

tagline
string | null

Short tagline (Ultra only, max 25 chars)

Maximum string length: 25
toyTagline
string | null

Toy tagline (max 25 chars)

Maximum string length: 25
iconId
integer | null

Icon ID (Ultra only)

isPublic
boolean

Whether the program is publicly shared

description
string | null

Program description (max 500 chars)

Maximum string length: 500
Segment
object[]

Full replacement segment list. If provided, all existing segments are deleted and replaced with these.

Required array length: 1 - 100 elements

Response

Updated settings with segments

ok
boolean
required
data
object
required