Skip to main content
POST
/
api
/
v1
/
appuid
/
{appUid}
/
labels
Create a new label
curl --request POST \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/labels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "externalId": "<string>",
  "showInDiscovery": true
}
'
import requests

url = "https://a.api.mindset.ai/api/v1/appuid/{appUid}/labels"

payload = {
"name": "<string>",
"externalId": "<string>",
"showInDiscovery": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', externalId: '<string>', showInDiscovery: true})
};

fetch('https://a.api.mindset.ai/api/v1/appuid/{appUid}/labels', 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://a.api.mindset.ai/api/v1/appuid/{appUid}/labels",
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>',
'externalId' => '<string>',
'showInDiscovery' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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://a.api.mindset.ai/api/v1/appuid/{appUid}/labels"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"showInDiscovery\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
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://a.api.mindset.ai/api/v1/appuid/{appUid}/labels")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"showInDiscovery\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://a.api.mindset.ai/api/v1/appuid/{appUid}/labels")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"showInDiscovery\": true\n}"

response = http.request(request)
puts response.read_body
{
  "uid": "<string>",
  "name": "<string>",
  "externalId": "<string>",
  "showInDiscovery": true,
  "createdAt": "2023-11-07T05:31:56Z"
}
This response has no body data.
This response has no body data.
This response has no body data.
This response has no body data.
This response has no body data.

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum string length: 1

Body

application/json
name
string
required

Name of the label

Minimum string length: 1
externalId
string

Optional External ID of the label

showInDiscovery
boolean

Is this label visible to end users?

Response

Label created successfully

uid
string

Unique ID of the label

name
string
externalId
string
showInDiscovery
boolean

Is this label visible to end users?

createdAt
string<date-time>

Creation timestamp (ISO 8601)