Dokument aktualisieren / erstellen
1 min
POST
https://api.archbee.com/api/public-api/doc
Header Parameters
- Content-TypestringrequiredExample
Body Parameters
- bodyobjectrequired
- contentstringrequiredExampleDescription
- formatstring<markdown | json>ExampleDescriptionAllowedmarkdownjson
- titlestringDescription
- descriptionstringDescription
- previewImgURLstringDescription
- slugstringDescription
- aliasstringDescription
- conditionalRuleIdstringDescription
- sortingstring<alphabetical | chronological>ExampleDescriptionAllowedalphabeticalchronological
- hiddenbooleanDescription
- docIdstringExampleDescription
- parentDocIdstringExampleDescription
Responses
200
- objectDescription
- statusstring<OK>DescriptionAllowedOK
- dataobject
- docIdstring
- newRecordboolean
400
- Response400
- statusstring<OK | Not OK>ExampleDescriptionAllowedOKNot OK
- messagesstring[]Example
[ "Some error message" ]
Description
curl
curl --request POST \
--url https://api.archbee.com/api/public-api/doc \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"content": "# this is a h1 title\nAnd this is a paragraph\n- list item 1\n- list item 2"
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"content": "# this is a h1 title\nAnd this is a paragraph\n- list item 1\n- list item 2"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.archbee.com/api/public-api/doc", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.archbee.com/api/public-api/doc")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"content": "# this is a h1 title\nAnd this is a paragraph\n- list item 1\n- list item 2"
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.archbee.com/api/public-api/doc"
payload = json.dumps({
"content": "# this is a h1 title\nAnd this is a paragraph\n- list item 1\n- list item 2"
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Process status
{
"status": "",
"data": {
"docId": "",
"newRecord": false
}
}400
// Invalid request
{
"status": "Not OK",
"messages": [
"Some error message"
]
}Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.