Get, create, or update a shareable
curl --request POST \
--url https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"content": {
"description": "description",
"image_url": "image_url",
"partner_content_id": "partner_content_id",
"title": "title",
"url": "url"
},
"data": {
"data_key": "data_key"
},
"key": "key",
"label": "label",
"preferred_code_prefixes": [
"preferred_code_prefixe"
]
}
'import requests
url = "https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update"
payload = {
"content": {
"description": "description",
"image_url": "image_url",
"partner_content_id": "partner_content_id",
"title": "title",
"url": "url"
},
"data": { "data_key": "data_key" },
"key": "key",
"label": "label",
"preferred_code_prefixes": ["preferred_code_prefixe"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: {
description: 'description',
image_url: 'image_url',
partner_content_id: 'partner_content_id',
title: 'title',
url: 'url'
},
data: {data_key: 'data_key'},
key: 'key',
label: 'label',
preferred_code_prefixes: ['preferred_code_prefixe']
})
};
fetch('https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update', 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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update",
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([
'content' => [
'description' => 'description',
'image_url' => 'image_url',
'partner_content_id' => 'partner_content_id',
'title' => 'title',
'url' => 'url'
],
'data' => [
'data_key' => 'data_key'
],
'key' => 'key',
'label' => 'label',
'preferred_code_prefixes' => [
'preferred_code_prefixe'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update"
payload := strings.NewReader("{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"content": {
"description": "<string>",
"image_url": "<string>",
"partner_content_id": "<string>",
"title": "<string>",
"url": "<string>"
},
"data": {},
"key": "<string>",
"label": "<string>",
"link": "<string>"
}Profiles
Get, create, or update a shareable
Returns an existing shareable, creates one if missing, or updates it when the request data differs. Combines get-or-create with in-place updates.
POST
/
api
/
v6
/
me
/
shareables
/
get-create-or-update
Get, create, or update a shareable
curl --request POST \
--url https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"content": {
"description": "description",
"image_url": "image_url",
"partner_content_id": "partner_content_id",
"title": "title",
"url": "url"
},
"data": {
"data_key": "data_key"
},
"key": "key",
"label": "label",
"preferred_code_prefixes": [
"preferred_code_prefixe"
]
}
'import requests
url = "https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update"
payload = {
"content": {
"description": "description",
"image_url": "image_url",
"partner_content_id": "partner_content_id",
"title": "title",
"url": "url"
},
"data": { "data_key": "data_key" },
"key": "key",
"label": "label",
"preferred_code_prefixes": ["preferred_code_prefixe"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: {
description: 'description',
image_url: 'image_url',
partner_content_id: 'partner_content_id',
title: 'title',
url: 'url'
},
data: {data_key: 'data_key'},
key: 'key',
label: 'label',
preferred_code_prefixes: ['preferred_code_prefixe']
})
};
fetch('https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update', 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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update",
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([
'content' => [
'description' => 'description',
'image_url' => 'image_url',
'partner_content_id' => 'partner_content_id',
'title' => 'title',
'url' => 'url'
],
'data' => [
'data_key' => 'data_key'
],
'key' => 'key',
'label' => 'label',
'preferred_code_prefixes' => [
'preferred_code_prefixe'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update"
payload := strings.NewReader("{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v6/me/shareables/get-create-or-update")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{brand}.extole.io/api/v6/me/shareables/get-create-or-update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": {\n \"description\": \"description\",\n \"image_url\": \"image_url\",\n \"partner_content_id\": \"partner_content_id\",\n \"title\": \"title\",\n \"url\": \"url\"\n },\n \"data\": {\n \"data_key\": \"data_key\"\n },\n \"key\": \"key\",\n \"label\": \"label\",\n \"preferred_code_prefixes\": [\n \"preferred_code_prefixe\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"content": {
"description": "<string>",
"image_url": "<string>",
"partner_content_id": "<string>",
"title": "<string>",
"url": "<string>"
},
"data": {},
"key": "<string>",
"label": "<string>",
"link": "<string>"
}Authorizations
HEADERQUERYCOOKIE
Body
application/json
⌘I
