Placeholders

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/Placeholders.json",
  "title": "Placeholders",
  "type": "array",
  "description": "Placeholders are generally job roles that must complete and/or sign the document. For example, a placeholder might be \u201cClient\u201d or \u201cLegal Department\u201d. When a document is created from the template, you assign a person to each placeholder.",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "A unique identifier that you will give to each placeholder. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more."
      },
      "name": {
        "type": "string",
        "description": "Name of the placeholder."
      },
      "preassigned_recipient_name": {
        "type": "string",
        "description": "In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name."
      },
      "preassigned_recipient_email": {
        "type": "string",
        "format": "email",
        "description": "In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email."
      }
    },
    "required": [
      "id",
      "name"
    ]
  }
}