Skip to main content
PUT
/
documents
Put Document
curl --request PUT \
  --url https://getunblocked.com/api/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "Password Reset Guide",
  "body": "To reset your password, visit ...",
  "uri": "https://my.company.com/apollo/ticket/123456"
}'
{
  "id": "12345678-abcd-123456789-123456789abc"
}

Authorizations

​
Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Body

application/json
​
collectionId
string<uuid>

The ID of the collection where the document will be added.

​
title
string

A short title for the document. Can be plain text, or gzip compressed then base64 encoded text.

Example:

"Password Reset Guide"

​
body
string

The body of the document. Structured text documents like Markdown or JSON are preferred. Can be plain text, or gzip compressed then base64 encoded text.

Example:

"To reset your password, visit ..."

​
uri
string

A URL of the original source document that uniquely identifies the document. These will be used in answer references to link back to the original source.

Example:

"https://my.company.com/apollo/ticket/123456"

Response

OK

​
id
string<uuid>

The ID of a resource that can be retrieved from the service.

Example:

"12345678-abcd-123456789-123456789abc"

⌘I