Put Document
Use this endpoint to create or update a document for a given collection.
Documents are unique by uri
across your organization.
If the document for uri
does not exist, it will be created.
If the document for uri
exists, it will be updated.
On success, an ID for the created or updated document will be returned.
Documents created or updated may take up to a minute to be available for use.
Authorizations
The API key to authenticate requests. Obtainable from the web dashboard.
Body
The ID of the collection where the document will be added.
A short title for the document. Can be plain text, or gzip compressed then base64 encoded text.
"Password Reset Guide"
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.
"To reset your password, visit ..."
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.
"https://my.company.com/apollo/ticket/123456"
Response
The ID of a resource that can be retrieved from the service.
"12345678-abcd-123456789-123456789abc"