Create content
curl --request POST \
--url https://api.usertour.io/v2/projects/{projectId}/content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"buildUrl": "<string>",
"themeId": "<string>"
}
'import requests
url = "https://api.usertour.io/v2/projects/{projectId}/content"
payload = {
"name": "<string>",
"buildUrl": "<string>",
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', buildUrl: '<string>', themeId: '<string>'})
};
fetch('https://api.usertour.io/v2/projects/{projectId}/content', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'buildUrl' => '<string>',
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usertour.io/v2/projects/{projectId}/content"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.usertour.io/v2/projects/{projectId}/content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usertour.io/v2/projects/{projectId}/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "content",
"name": "<string>",
"buildUrl": "<string>",
"editedVersionId": "<string>",
"environments": [
{
"environmentId": "<string>",
"published": true,
"publishedVersionId": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"publishedVersion": {
"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>"
}
}
],
"deleted": true,
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"editedVersion": {
"id": "<string>",
"object": "contentVersion",
"number": 123,
"firstPublishedAt": "<string>",
"themeId": "<string>",
"questions": [
{
"object": "question",
"cvid": "<string>",
"name": "<string>"
}
],
"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>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}Content
Create content
POST
/
v2
/
projects
/
{projectId}
/
content
Create content
curl --request POST \
--url https://api.usertour.io/v2/projects/{projectId}/content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"buildUrl": "<string>",
"themeId": "<string>"
}
'import requests
url = "https://api.usertour.io/v2/projects/{projectId}/content"
payload = {
"name": "<string>",
"buildUrl": "<string>",
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', buildUrl: '<string>', themeId: '<string>'})
};
fetch('https://api.usertour.io/v2/projects/{projectId}/content', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'buildUrl' => '<string>',
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usertour.io/v2/projects/{projectId}/content"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.usertour.io/v2/projects/{projectId}/content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usertour.io/v2/projects/{projectId}/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"buildUrl\": \"<string>\",\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "content",
"name": "<string>",
"buildUrl": "<string>",
"editedVersionId": "<string>",
"environments": [
{
"environmentId": "<string>",
"published": true,
"publishedVersionId": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"publishedVersion": {
"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>"
}
}
],
"deleted": true,
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"editedVersion": {
"id": "<string>",
"object": "contentVersion",
"number": 123,
"firstPublishedAt": "<string>",
"themeId": "<string>",
"questions": [
{
"object": "question",
"cvid": "<string>",
"name": "<string>"
}
],
"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>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Project ID
Body
application/json
Content kind. An announcement is a feed item delivered through a resource center that has an announcement block — publish alone does not surface it without one.
Available options:
checklist, flow, launcher, banner, tracker, resource-center, announcement Display name. For announcement it also seeds the draft title.
Minimum string length:
1URL of the app page where this content is authored and previewed. Metadata only — no effect on runtime targeting (start rules control where content shows).
Theme applied to the initial draft version. Required for every type except tracker (which has no UI) — content has no usable styling without one. List options with the themes endpoint; use the one with isDefault if unsure.
Response
Content created
Available options:
content Available options:
checklist, flow, launcher, banner, tracker, resource-center, announcement URL of the app page where this content is authored and previewed (the visual editor opens it there). Metadata only — it plays NO part in runtime targeting; where content shows is controlled by its start rules.
Where this content is live RIGHT NOW: one row per environment it is currently published to (empty = published nowhere). Rows disappear on unpublish.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I