curl -X DELETE "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e3/docs/60b8d6f1e1b9b1d8c6c0d8f5" \
-H "X-Api-Key: $OLLANG_API_KEY"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
const docId = "60b8d6f1e1b9b1d8c6c0d8f5";
await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}/docs/${docId}`,
{
method: "DELETE",
headers: {
"X-Api-Key": process.env.OLLANG_API_KEY,
},
},
);
import os
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e3"
doc_id = "60b8d6f1e1b9b1d8c6c0d8f5"
requests.delete(
f"https://api-integration.ollang.com/integration/project/{project_id}/docs/{doc_id}",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e3';
$docId = '60b8d6f1e1b9b1d8c6c0d8f5';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api-integration.ollang.com/integration/project/{$projectId}/docs/{$docId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'X-Api-Key: ' . getenv('OLLANG_API_KEY')
),
));
curl_exec($curl);
curl_close($curl);
package main
import (
"net/http"
"os"
)
func main() {
projectID := "60b8d6f1e1b9b1d8c6c0d8e3"
docID := "60b8d6f1e1b9b1d8c6c0d8f5"
url := "https://api-integration.ollang.com/integration/project/" + projectID + "/docs/" + docID
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Set("X-Api-Key", os.Getenv("OLLANG_API_KEY"))
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
String docId = "60b8d6f1e1b9b1d8c6c0d8f5";
Unirest
.delete("https://api-integration.ollang.com/integration/project/" + projectId + "/docs/" + docId)
.header("X-Api-Key", System.getenv("OLLANG_API_KEY"))
.asString();
{}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"statusCode": 403,
"message": "You don't have permission to perform this action. Please contact your account admin.",
"error": "Forbidden"
}
{
"statusCode": 404,
"message": "Document not found",
"error": "Not Found"
}
Ollang API Reference
Remove Project Document
Detach a guideline, glossary, or character list from a single project
DELETE
/
integration
/
project
/
{projectId}
/
docs
/
{docId}
curl -X DELETE "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e3/docs/60b8d6f1e1b9b1d8c6c0d8f5" \
-H "X-Api-Key: $OLLANG_API_KEY"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
const docId = "60b8d6f1e1b9b1d8c6c0d8f5";
await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}/docs/${docId}`,
{
method: "DELETE",
headers: {
"X-Api-Key": process.env.OLLANG_API_KEY,
},
},
);
import os
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e3"
doc_id = "60b8d6f1e1b9b1d8c6c0d8f5"
requests.delete(
f"https://api-integration.ollang.com/integration/project/{project_id}/docs/{doc_id}",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e3';
$docId = '60b8d6f1e1b9b1d8c6c0d8f5';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api-integration.ollang.com/integration/project/{$projectId}/docs/{$docId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'X-Api-Key: ' . getenv('OLLANG_API_KEY')
),
));
curl_exec($curl);
curl_close($curl);
package main
import (
"net/http"
"os"
)
func main() {
projectID := "60b8d6f1e1b9b1d8c6c0d8e3"
docID := "60b8d6f1e1b9b1d8c6c0d8f5"
url := "https://api-integration.ollang.com/integration/project/" + projectID + "/docs/" + docID
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Set("X-Api-Key", os.Getenv("OLLANG_API_KEY"))
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
String docId = "60b8d6f1e1b9b1d8c6c0d8f5";
Unirest
.delete("https://api-integration.ollang.com/integration/project/" + projectId + "/docs/" + docId)
.header("X-Api-Key", System.getenv("OLLANG_API_KEY"))
.asString();
{}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"statusCode": 403,
"message": "You don't have permission to perform this action. Please contact your account admin.",
"error": "Forbidden"
}
{
"statusCode": 404,
"message": "Document not found",
"error": "Not Found"
}
Removes a document from a project.
- For a document attached to the project itself, the document is deleted.
- For a folder document listed for the project (its
folderIdis set), the folder document stops applying to this project only. The folder keeps the document, and the folder’s other projects keep using it. To remove it from every project in the folder, use Remove Folder Document instead.
Orders created before the removal keep the guidance they were already
processed with. The removal affects work that runs after it.
curl -X DELETE "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e3/docs/60b8d6f1e1b9b1d8c6c0d8f5" \
-H "X-Api-Key: $OLLANG_API_KEY"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
const docId = "60b8d6f1e1b9b1d8c6c0d8f5";
await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}/docs/${docId}`,
{
method: "DELETE",
headers: {
"X-Api-Key": process.env.OLLANG_API_KEY,
},
},
);
import os
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e3"
doc_id = "60b8d6f1e1b9b1d8c6c0d8f5"
requests.delete(
f"https://api-integration.ollang.com/integration/project/{project_id}/docs/{doc_id}",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e3';
$docId = '60b8d6f1e1b9b1d8c6c0d8f5';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api-integration.ollang.com/integration/project/{$projectId}/docs/{$docId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'X-Api-Key: ' . getenv('OLLANG_API_KEY')
),
));
curl_exec($curl);
curl_close($curl);
package main
import (
"net/http"
"os"
)
func main() {
projectID := "60b8d6f1e1b9b1d8c6c0d8e3"
docID := "60b8d6f1e1b9b1d8c6c0d8f5"
url := "https://api-integration.ollang.com/integration/project/" + projectID + "/docs/" + docID
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Set("X-Api-Key", os.Getenv("OLLANG_API_KEY"))
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e3";
String docId = "60b8d6f1e1b9b1d8c6c0d8f5";
Unirest
.delete("https://api-integration.ollang.com/integration/project/" + projectId + "/docs/" + docId)
.header("X-Api-Key", System.getenv("OLLANG_API_KEY"))
.asString();
Authorizations
This endpoint requires API key authentication. Include your API key in the request header:- Header name:
X-Api-Key - Header value: Your API key from the Ollang dashboard
- Format:
X-Api-Key: your-api-key-here
OLLANG_API_KEY environment variable; set it before running them.
The project must belong to the API key’s account; other projects return 404.
The API key user also needs write access, the same as for folder documents: the
account owner, team-manager or order-creator role, or project manager of the
project’s folder. Other keys, such as view-only users, receive a 403.
Path Parameters
string
required
The unique identifier of the project the document belongs to.
string
required
The unique identifier of the project document. Retrieve document IDs with
List Project Documents.
Response
Returns an empty body on success.{}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"statusCode": 403,
"message": "You don't have permission to perform this action. Please contact your account admin.",
"error": "Forbidden"
}
{
"statusCode": 404,
"message": "Document not found",
"error": "Not Found"
}
Was this page helpful?