This page was automatically generated from tracezilla’s Swagger API documentation 2026-10-19

POST /send-custom-document-to-connection/{connectionRef}/{templateRef}

Send custom document through connection

Parameters (path)

Name Required Description Values
connectionRef required Reference code of connection.  
templateRef required Reference code of template.  

Request body

Description

Data to store.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12

{
  "required": [
    "entity_id"
  ],
  "properties": {
    "description": "Id of entity to create the document for",
    "type": "string",
    "format": "uuid",
    "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "properties": {
    "status": {
      "type": "string",
      "example": "success"
    },
    "message": {
      "type": "string",
      "example": "Success message"
    }
  },
  "type": "object"
}

406

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "properties": {
    "status": {
      "type": "string",
      "example": "error"
    },
    "message": {
      "type": "string",
      "example": "Error message"
    }
  },
  "type": "object"
}

403

Unauthorized request

500

Internal server error