Data

Add a document

Adds a JSON document of at most 64 kB to the collection; with a schema on the collection, it must match. At most 10000 documents per collection. The collection's triggers fire just as for a form: document.created if webhook_on_insert is on (including in test mode), and an email if email_on_insert is on (not in test mode).

post/collections/{id}/documents

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/collections/{id}/documents
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: data:write)

Path parameters

idstring required

The id of the collection, or its name.

Request body

dataobject required

The document: any JSON object, at most 64 kB.

Response

The new document.

idstring uuid required

The id of the document.

collection_idstring uuid required

The id of its collection.

dataobject required

The document itself: a JSON object.

source'api' | 'public' required

api: added with an API key. public: sent from a form on a website.

created_atstring date-time required

When the document was added.

updated_atstring date-time required

When the document last changed.

testboolean required

true for a document of a test project. No email was sent for it.

Changes

No recorded changes to this operation across all 1 revision of this API.