Assign Tag
curl --request POST \
--url https://app.octavehq.com/api/v2/tag/assign \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"entityType": "use_case",
"entityOId": "uu_1234",
"tagOId": "tag_1234"
}
'import requests
url = "https://app.octavehq.com/api/v2/tag/assign"
payload = {
"entityType": "use_case",
"entityOId": "uu_1234",
"tagOId": "tag_1234"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityType: 'use_case', entityOId: 'uu_1234', tagOId: 'tag_1234'})
};
fetch('https://app.octavehq.com/api/v2/tag/assign', 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://app.octavehq.com/api/v2/tag/assign",
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([
'entityType' => 'use_case',
'entityOId' => 'uu_1234',
'tagOId' => 'tag_1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/tag/assign"
payload := strings.NewReader("{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/tag/assign")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/tag/assign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"entityType": "use_case",
"entityOId": "<string>",
"tagOId": "<string>",
"success": true
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Tag
Assign Tag
Assign a tag value to a library entity. An entity carries at most one value per group, so this replaces any value it already had in that group. The tag’s group must be for the same entity type.
POST
/
api
/
v2
/
tag
/
assign
Assign Tag
curl --request POST \
--url https://app.octavehq.com/api/v2/tag/assign \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"entityType": "use_case",
"entityOId": "uu_1234",
"tagOId": "tag_1234"
}
'import requests
url = "https://app.octavehq.com/api/v2/tag/assign"
payload = {
"entityType": "use_case",
"entityOId": "uu_1234",
"tagOId": "tag_1234"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityType: 'use_case', entityOId: 'uu_1234', tagOId: 'tag_1234'})
};
fetch('https://app.octavehq.com/api/v2/tag/assign', 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://app.octavehq.com/api/v2/tag/assign",
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([
'entityType' => 'use_case',
'entityOId' => 'uu_1234',
'tagOId' => 'tag_1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/tag/assign"
payload := strings.NewReader("{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/tag/assign")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/tag/assign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"use_case\",\n \"entityOId\": \"uu_1234\",\n \"tagOId\": \"tag_1234\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"entityType": "use_case",
"entityOId": "<string>",
"tagOId": "<string>",
"success": true
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
The library entity type a tag group applies to. Its values can only be assigned to entities of this type.
Available options:
segment, persona, use_case, proof_point, reference, competitor, alternative, buying_trigger, objection, product, service, solution, core_feature Example:
"use_case"
OId of the library entity to tag
Minimum string length:
1Example:
"uu_1234"
Tag OId to assign
Minimum string length:
1Example:
"tag_1234"