Skip to content

Create a document

POST /api/document

Create a new Formbird document

Arguments
  • your apiKey, for example: bf5b0500-9332-11e6-9c03-853f647fe4a4

  • the document you wish to create, for example:

json { "systemHeader": { "templateId": "547fe84c9c1d86680d9806bd" }, "text": "apiTest" }

Example Request
curl http://localhost:3000/api/document \
 -H "Content-Type: application/json;charset=UTF-8" \
 -H "apiKey: bf5b0500-9332-11e6-9c03-853f647fe4a4" \
 -d "{\"systemHeader\": {\"templateId\": \"547fe84c9c1d86680d9806bd\"},\"text\": \"apiTest\"}"
Example Response
{
    "systemHeader": {
        "templateId": "547fe84c9c1d86680d9806bd",
        "keyIds": [],
        "serverUpdatedDate": "2017-09-08T03:07:37.380Z",
        "serverCreatedDate": "2017-09-08T03:07:37.380Z",
        "versionId": "de24de40-9442-11e7-a6b2-d9cc8e84f3a6",
        "excludeGeneralSearch": false,
        "systemType": "document",
        "currentVersion": true,
        "createdDate": "2017-09-08T03:07:37.380Z",
        "createdBy": "548684a629a5e8d820b12c01",
        "summaryName": "apiTest",
        "summaryDescription": "apiTest"
    },
    "text": "apiTest",
    "documentId": "dcfc63d0-9442-11e7-a6b2-d9cc8e84f3a6"
}

The response contains the document created