Send template

POST 
/proposals/templates/send

Send template to a client

Request

Version stringrequired

API Version

Available options2023-02-21

application/json

application/json

Body

Bodyrequired

templateIdstringrequired

Template Id

userIdstringrequired

User Id

sendDocumentboolean

Send Document

locationIdstringrequired

Location Id

contactIdstringrequired

Contact Id

opportunityIdstring

Opportunity Id

Example (auto)

{
  "templateId": "hTlkh7t8gujsahgg93",
  "userId": "hTlkh7t8gujsahgg93",
  "sendDocument": true,
  "locationId": "hTlkh7t8gujsahgg93",
  "contactId": "hTlkh7t8gujsahgg93",
  "opportunityId": "hTlkh7t8gujsahgg93"
}

application/json

Document sent successfully

application/json

Schema

Schema

successbooleanrequired

Success status

linksobject[]required

Links for all recipients

Example (auto)

{
  "success": true,
  "links": [
    {
      "referenceId": "550e8400-e29b-41d4-a716-446655440000",
      "documentId": "c1e87a91-93b2-4b78-821f-85cf0e1f925b",
      "recipientId": "u240JcS0E5qE0ziHnwMm",
      "entityName": "contacts",
      "recipientCategory": "recipient",
      "documentRevision": 1,
      "createdBy": "b6d8fa28-1112-4dc7-b9d2-f22b75a477ea",
      "deleted": false
    }
  ]
}