Create a content version

curl --request POST \
  --url https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions"

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

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

print(response.text)

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

fetch('https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions', 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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions"

	req, _ := http.NewRequest("POST", 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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions")

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

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

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

{
  "id": "<string>",
  "object": "contentVersion",
  "number": 123,
  "firstPublishedAt": "<string>",
  "themeId": "<string>",
  "questions": [
    {
      "object": "question",
      "cvid": "<string>",
      "name": "<string>"
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "steps": [
    {
      "object": "step",
      "id": "<string>",
      "cvid": "<string>",
      "name": "<string>",
      "sequence": 123,
      "themeId": "<string>",
      "content": [
        {
          "type": "text",
          "markdown": "<string>",
          "object": "block",
          "id": "<string>"
        }
      ],
      "target": {
        "selector": "<string>",
        "text": "<string>",
        "nth": 2
      },
      "placement": {
        "sideOffset": 123,
        "alignOffset": 123,
        "backdrop": true,
        "blockTarget": true
      },
      "width": 123,
      "skippable": true,
      "explicitCompletionStep": true,
      "triggers": [
        {
          "do": [
            {
              "type": "goto_step",
              "step": "<string>"
            }
          ],
          "when": [
            {
              "type": "group",
              "conditions": "<array>"
            }
          ],
          "waitSeconds": 123
        }
      ],
      "onClick": [
        {
          "type": "goto_step",
          "step": "<string>"
        }
      ],
      "advanced": {
        "hasUnsupported": true
      }
    }
  ],
  "startRules": {
    "when": [
      {
        "type": "group",
        "conditions": "<array>"
      }
    ],
    "frequency": {
      "every": {
        "duration": 123,
        "times": 123
      },
      "atLeast": {
        "duration": 123
      }
    },
    "waitSeconds": 123,
    "startIfNotComplete": true
  },
  "hideRules": {
    "when": [
      {
        "type": "group",
        "conditions": "<array>"
      }
    ]
  },
  "data": "<unknown>",
  "scheduledAt": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

POST

projects

{projectId}

content

{contentId}

versions

Create a content version

curl --request POST \
  --url https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions"

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

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

print(response.text)

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

fetch('https://api.usertour.io/v2/projects/{projectId}/content/{contentId}/versions', 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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions"

	req, _ := http.NewRequest("POST", 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.usertour.io/v2/projects/{projectId}/content/{contentId}/versions")

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

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

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

{
  "id": "<string>",
  "object": "contentVersion",
  "number": 123,
  "firstPublishedAt": "<string>",
  "themeId": "<string>",
  "questions": [
    {
      "object": "question",
      "cvid": "<string>",
      "name": "<string>"
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "steps": [
    {
      "object": "step",
      "id": "<string>",
      "cvid": "<string>",
      "name": "<string>",
      "sequence": 123,
      "themeId": "<string>",
      "content": [
        {
          "type": "text",
          "markdown": "<string>",
          "object": "block",
          "id": "<string>"
        }
      ],
      "target": {
        "selector": "<string>",
        "text": "<string>",
        "nth": 2
      },
      "placement": {
        "sideOffset": 123,
        "alignOffset": 123,
        "backdrop": true,
        "blockTarget": true
      },
      "width": 123,
      "skippable": true,
      "explicitCompletionStep": true,
      "triggers": [
        {
          "do": [
            {
              "type": "goto_step",
              "step": "<string>"
            }
          ],
          "when": [
            {
              "type": "group",
              "conditions": "<array>"
            }
          ],
          "waitSeconds": 123
        }
      ],
      "onClick": [
        {
          "type": "goto_step",
          "step": "<string>"
        }
      ],
      "advanced": {
        "hasUnsupported": true
      }
    }
  ],
  "startRules": {
    "when": [
      {
        "type": "group",
        "conditions": "<array>"
      }
    ],
    "frequency": {
      "every": {
        "duration": 123,
        "times": 123
      },
      "atLeast": {
        "duration": 123
      }
    },
    "waitSeconds": 123,
    "startIfNotComplete": true
  },
  "hideRules": {
    "when": [
      {
        "type": "group",
        "conditions": "<array>"
      }
    ]
  },
  "data": "<unknown>",
  "scheduledAt": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "issues": [
      {
        "rule": "<string>",
        "message": "<string>",
        "path": "<string>"
      }
    ],
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId

string

required

Project ID

contentId

string

required

Content ID

Response

Created content version

string

required

object

enum<string>

required

Available options:

contentVersion

number

required

firstPublishedAt

string | null

required

When this version FIRST went live (ISO). Non-null means the version is frozen: it can never be edited again — not even after unpublishing — edit by forking (by forking). null means it never went live — OR its first publish predates this stamp (older versions were never backfilled), so on old data null is not proof it never shipped. This is history, not live state: for "is it live NOW, where" read the content's environments[]; for who published what when, the publish history (available through the MCP).

themeId

string | null

required

questions

object[] | null

required

Show child attributes

updatedAt

string<date-time>

required

createdAt

string<date-time>

required

steps

object[]

Show child attributes

startRules

object

Show child attributes

hideRules

object

While when matches, on-screen content of this version is hidden — the session is SUSPENDED, not ended: when the conditions stop matching the same session reappears at the same step. Use start-rule conditions to keep content from starting; use hide rules to blank it in specific places (e.g. a settings page).

Show child attributes

data

any

Decompiled type-specific body for non-flow content — the same six per-type shapes as the write data (that schema is the field dictionary), fully populated on read. Present only when the data expand is requested; a flow has no data — its body is steps.

scheduledAt

string

Announcement versions only: the "announcement time" gating feed visibility and ordering. Absent on other content types and until set (publish stamps it when the author left it null, so published announcements always carry one).

Getting started

Conventions

Concepts

Endpoints

Create a content version

Authorizations

Path Parameters

Response