Create a legal hold
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/legal-holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reason": "<string>",
"conversation_id": "<string>",
"handle": {
"value": "<string>",
"scope": "<string>"
},
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
}
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/legal-holds"
payload = {
"reason": "<string>",
"conversation_id": "<string>",
"handle": {
"value": "<string>",
"scope": "<string>"
},
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reason: '<string>',
conversation_id: '<string>',
handle: {value: '<string>', scope: '<string>'},
object: {id: '<string>', namespace: '<string>', type: '<string>'}
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/legal-holds', 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://{space}.{region}.api.niadra.com/v1/legal-holds",
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([
'reason' => '<string>',
'conversation_id' => '<string>',
'handle' => [
'value' => '<string>',
'scope' => '<string>'
],
'object' => [
'id' => '<string>',
'namespace' => '<string>',
'type' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://{space}.{region}.api.niadra.com/v1/legal-holds"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://{space}.{region}.api.niadra.com/v1/legal-holds")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/legal-holds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"hold_id": "<string>",
"scope": "handle",
"status": "active",
"released_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Signals and constraints
Create a legal hold
Keeps the data of a handle, an object or a conversation out of purging until the release. The legal_holds feature.
POST
/
v1
/
legal-holds
Create a legal hold
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/legal-holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reason": "<string>",
"conversation_id": "<string>",
"handle": {
"value": "<string>",
"scope": "<string>"
},
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
}
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/legal-holds"
payload = {
"reason": "<string>",
"conversation_id": "<string>",
"handle": {
"value": "<string>",
"scope": "<string>"
},
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reason: '<string>',
conversation_id: '<string>',
handle: {value: '<string>', scope: '<string>'},
object: {id: '<string>', namespace: '<string>', type: '<string>'}
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/legal-holds', 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://{space}.{region}.api.niadra.com/v1/legal-holds",
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([
'reason' => '<string>',
'conversation_id' => '<string>',
'handle' => [
'value' => '<string>',
'scope' => '<string>'
],
'object' => [
'id' => '<string>',
'namespace' => '<string>',
'type' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://{space}.{region}.api.niadra.com/v1/legal-holds"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://{space}.{region}.api.niadra.com/v1/legal-holds")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/legal-holds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"handle\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n },\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"hold_id": "<string>",
"scope": "handle",
"status": "active",
"released_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Authorizations
sourceKeypersonToken
nia_sk_...
Headers
Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.
Required string length:
1 - 256Body
application/json
Exactly one of handle, object or conversation_id: what is kept from purging while the hold is
active.
Required string length:
1 - 500Required string length:
1 - 512An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.
Show child attributes
Show child attributes
A business object in a system of record, e.g. invoice / erp / 0823.
Show child attributes
Show child attributes

