openapi: 3.0.3 info: title: BoldSign Branding Template API version: '1' description: BoldSign eSignature REST API for sending documents for electronic signature, managing reusable templates, tracking envelope status, embedding signing and requesting workflows into third-party applications. Supports API key and OAuth 2.0 authentication. Regional endpoints available for US, EU, CA, and AU. contact: name: BoldSign Support url: https://developers.boldsign.com/ email: support@boldsign.com license: name: Proprietary url: https://boldsign.com/terms-of-use/ termsOfService: https://boldsign.com/terms-of-use/ servers: - url: https://api.boldsign.com description: US production - url: https://eu.boldsign.com description: EU production - url: https://ca.boldsign.com description: CA production - url: https://au.boldsign.com description: AU production security: - Bearer: [] - X-API-KEY: [] tags: - name: Template paths: /v1/template/list: get: tags: - Template summary: List all the templates. operationId: ListTemplates parameters: - name: TemplateType in: query schema: title: TemplateType enum: - mytemplates - sharedtemplate - all type: string - name: PageSize in: query schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query required: true schema: title: Int32 type: integer format: int32 default: 1 - name: SearchKey in: query schema: title: String type: string - name: OnBehalfOf in: query description: The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. schema: title: List`1 type: array items: title: String type: string - name: CreatedBy in: query description: The templates can be listed by the creator of the template. schema: title: List`1 type: array items: title: String type: string - name: TemplateLabels in: query description: Labels of the template. schema: title: List`1 type: array items: title: String type: string - name: StartDate in: query description: Start date of the template schema: title: Nullable`1 type: string format: date-time - name: EndDate in: query description: End date of the template schema: title: Nullable`1 type: string format: date-time - name: BrandIds in: query description: BrandId(s) of the template. schema: title: List`1 type: array items: title: String type: string - name: SharedWithTeamId in: query description: The templates can be listed by the shared teams. schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TemplateRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/create: post: tags: - Template summary: Creates a new template. operationId: CreateTemplate requestBody: description: The create template request body. content: application/json: schema: $ref: '#/components/schemas/CreateTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateTemplateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateTemplateRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TemplateCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/createEmbeddedTemplateUrl: post: tags: - Template summary: Generates a create URL to embeds template create process into your application. operationId: CreateEmbeddedTemplateUrl requestBody: description: The create embedded template request body. content: application/json: schema: $ref: '#/components/schemas/EmbeddedCreateTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedCreateTemplateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedCreateTemplateRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedTemplateCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/getEmbeddedTemplateEditUrl: post: tags: - Template summary: Generates a edit URL to embeds template edit process into your application. operationId: getEmbeddedTemplateEditUrl parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: The embedded edit template request body. content: application/json: schema: $ref: '#/components/schemas/EmbeddedTemplateEditRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedTemplateEditRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedTemplateEditRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedTemplateEdited' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/delete: delete: tags: - Template summary: Deletes a template. operationId: DeleteTemplate parameters: - name: templateId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/send: post: tags: - Template summary: Send a document for signature using a Template. operationId: SendUsingTemplate parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: The send template details as JSON. content: application/json: schema: $ref: '#/components/schemas/SendForSignFromTemplateForm' multipart/form-data: schema: $ref: '#/components/schemas/SendForSignFromTemplateForm' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendForSignFromTemplateForm' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DocumentCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/mergeAndSend: post: tags: - Template summary: Send the document by merging multiple templates. operationId: MergeAndSend requestBody: description: The merge and send details as JSON. content: application/json: schema: $ref: '#/components/schemas/MergeAndSendForSignForm' multipart/form-data: schema: $ref: '#/components/schemas/MergeAndSendForSignForm' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MergeAndSendForSignForm' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DocumentCreated' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/createEmbeddedRequestUrl: post: tags: - Template summary: Generates a send URL using a template which embeds document sending process into your application. operationId: CreateEmbeddedRequestUrlTemplate parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: Embedded send template json request. content: application/json: schema: $ref: '#/components/schemas/EmbeddedSendTemplateFormRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedSendTemplateFormRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedSendTemplateFormRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedSendCreated' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/mergeCreateEmbeddedRequestUrl: post: tags: - Template summary: Generates a merge request URL using a template that combines document merging and sending processes into your application. operationId: MergeCreateEmbeddedRequestUrlTemplate requestBody: description: Embedded merge and send template json request. content: application/json: schema: $ref: '#/components/schemas/EmbeddedMergeTemplateFormRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedMergeTemplateFormRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedMergeTemplateFormRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedSendCreated' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/properties: get: tags: - Template summary: Get summary of the template. operationId: GetTemplateProperties parameters: - name: templateId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TemplateProperties' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' x-operation-name: GetProperties /v1/template/download: get: tags: - Template summary: Download the template. operationId: Download parameters: - name: templateId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string - name: includeFormFieldValues in: query schema: title: Boolean type: boolean default: false responses: '200': description: OK content: application/json: schema: title: FileStreamResult type: string format: binary '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/edit: put: tags: - Template summary: Edit and updates an existing template. operationId: EditTemplate parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: The edit template request body. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditTemplateRequest' application/xml: schema: $ref: '#/components/schemas/EditTemplateRequest' text/plain: schema: $ref: '#/components/schemas/EditTemplateRequest' application/json-patch+json: schema: $ref: '#/components/schemas/EditTemplateRequest' text/json: schema: $ref: '#/components/schemas/EditTemplateRequest' application/*+json: schema: $ref: '#/components/schemas/EditTemplateRequest' required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/addTags: patch: tags: - Template summary: Add the Tags in Templates. operationId: AddTemplateTag requestBody: description: ContainsTemplateId and Label Names for AddingTags. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/xml: schema: $ref: '#/components/schemas/TemplateTag' text/plain: schema: $ref: '#/components/schemas/TemplateTag' application/json-patch+json: schema: $ref: '#/components/schemas/TemplateTag' text/json: schema: $ref: '#/components/schemas/TemplateTag' application/*+json: schema: $ref: '#/components/schemas/TemplateTag' responses: '200': description: OK '400': description: Bad Request content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/xml: schema: $ref: '#/components/schemas/ErrorResult' text/plain: schema: $ref: '#/components/schemas/ErrorResult' application/octet-stream: schema: $ref: '#/components/schemas/ErrorResult' text/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/xml: schema: $ref: '#/components/schemas/ErrorResult' text/plain: schema: $ref: '#/components/schemas/ErrorResult' application/octet-stream: schema: $ref: '#/components/schemas/ErrorResult' text/json: schema: $ref: '#/components/schemas/ErrorResult' x-operation-name: AddTag /v1/template/deleteTags: delete: tags: - Template summary: Delete the Tags in Templates. operationId: DeleteTemplateTag requestBody: description: Contains TemplateId and LabelNames for Adding Tags. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateTag' application/json: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateTag' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateTag' application/xml: schema: $ref: '#/components/schemas/TemplateTag' text/plain: schema: $ref: '#/components/schemas/TemplateTag' application/json-patch+json: schema: $ref: '#/components/schemas/TemplateTag' text/json: schema: $ref: '#/components/schemas/TemplateTag' application/*+json: schema: $ref: '#/components/schemas/TemplateTag' responses: '200': description: OK '401': description: Unauthorized content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/xml: schema: $ref: '#/components/schemas/ErrorResult' text/plain: schema: $ref: '#/components/schemas/ErrorResult' application/octet-stream: schema: $ref: '#/components/schemas/ErrorResult' text/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ErrorResult' application/json: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ErrorResult' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ErrorResult' application/xml: schema: $ref: '#/components/schemas/ErrorResult' text/plain: schema: $ref: '#/components/schemas/ErrorResult' application/octet-stream: schema: $ref: '#/components/schemas/ErrorResult' text/json: schema: $ref: '#/components/schemas/ErrorResult' x-operation-name: DeleteTag /v1/template/share: patch: tags: - Template summary: Share a template with teams and manage permissions. operationId: ShareTemplate parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: Permissions request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TemplateShareRequest' application/xml: schema: $ref: '#/components/schemas/TemplateShareRequest' text/plain: schema: $ref: '#/components/schemas/TemplateShareRequest' application/json-patch+json: schema: $ref: '#/components/schemas/TemplateShareRequest' text/json: schema: $ref: '#/components/schemas/TemplateShareRequest' application/*+json: schema: $ref: '#/components/schemas/TemplateShareRequest' required: true responses: '200': description: OK '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/TemplateShareErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/TemplateShareErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/template/createEmbeddedPreviewUrl: post: tags: - Template summary: Generates a preview URL for a template to view it. operationId: createEmbeddedPreviewUrl parameters: - name: templateId in: query required: true schema: title: String type: string requestBody: description: The embedded template preview request body. content: application/json: schema: $ref: '#/components/schemas/EmbeddedTemplatePreviewJsonRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedTemplatePreviewJsonRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedTemplatePreviewJsonRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmbeddedTemplatePreview' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' components: schemas: FormulaFieldSettings: title: FormulaFieldSettings type: object properties: formulaExpression: title: String type: string nullable: true decimalPrecision: title: Int32 type: integer format: int32 default: 0 additionalProperties: false TextTagOffset: title: TextTagOffset type: object properties: offsetX: title: Double type: number format: double offsetY: title: Double type: number format: double additionalProperties: false PageDetails: title: PageDetails type: object properties: pageSize: title: Int32 type: integer format: int32 page: title: Int32 type: integer format: int32 totalRecordsCount: title: Int32 type: integer format: int32 totalPages: title: Int32 type: integer format: int32 sortedColumn: title: String type: string nullable: true sortDirection: title: String type: string nullable: true additionalProperties: false DocumentCC: title: DocumentCC required: - emailAddress type: object properties: emailAddress: title: String minLength: 1 type: string additionalProperties: false FormField: title: FormField required: - bounds - fieldType - pageNumber type: object properties: id: title: String type: string nullable: true name: title: String type: string nullable: true fieldType: title: FieldType enum: - Signature - Initial - CheckBox - TextBox - Label - DateSigned - RadioButton - Image - Attachment - EditableDate - Hyperlink - Dropdown - Title - Company - Formula - Drawing type: string pageNumber: title: Int32 type: integer format: int32 bounds: $ref: '#/components/schemas/Rectangle' isRequired: title: Boolean type: boolean isReadOnly: title: Boolean type: boolean value: title: String type: string nullable: true fontSize: title: Single minimum: 0 type: number format: float font: title: FontFamily enum: - Helvetica - Courier - TimesRoman - NotoSans - Carlito type: string fontHexColor: title: String type: string nullable: true isBoldFont: title: Boolean type: boolean isItalicFont: title: Boolean type: boolean isUnderLineFont: title: Boolean type: boolean lineHeight: title: Int32 maximum: 2147483647 minimum: 0 type: integer format: int32 characterLimit: title: Int32 maximum: 2147483647 minimum: 0 type: integer format: int32 groupName: title: String type: string nullable: true label: title: String type: string nullable: true placeHolder: title: String type: string nullable: true validationType: title: ValidationType enum: - None - NumbersOnly - EmailAddress - Currency - CustomRegex type: string validationCustomRegex: title: String type: string nullable: true validationCustomRegexMessage: title: String type: string nullable: true dateFormat: title: String type: string nullable: true timeFormat: title: String type: string nullable: true imageInfo: $ref: '#/components/schemas/ImageInfo' attachmentInfo: $ref: '#/components/schemas/AttachmentInfo' editableDateFieldSettings: $ref: '#/components/schemas/EditableDateFieldSettings' hyperlinkText: title: String type: string nullable: true conditionalRules: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/ConditionalRule' nullable: true dataSyncTag: title: String type: string nullable: true dropdownOptions: title: String[] type: array items: title: String type: string nullable: true textAlign: title: TextAlign enum: - Left - Center - Right type: string textDirection: title: TextDirection enum: - LTR - RTL type: string characterSpacing: title: Single type: number format: float backgroundHexColor: title: String type: string nullable: true tabIndex: title: Nullable`1 maximum: 2147483647 minimum: -1 type: integer format: int32 nullable: true formulaFieldSettings: $ref: '#/components/schemas/FormulaFieldSettings' resizeOption: title: Nullable`1 enum: - GrowVertically - GrowHorizontally - GrowBoth - Fixed - AutoResizeFont type: string nullable: true allowEditFormField: title: Nullable`1 type: boolean nullable: true allowDeleteFormField: title: Nullable`1 type: boolean nullable: true collaborationSettings: $ref: '#/components/schemas/CollaborationSettings' isMasked: title: Nullable`1 type: boolean default: false nullable: true isDefaultValueRequired: title: Nullable`1 type: boolean nullable: true additionalProperties: false Template: title: Template type: object properties: documentId: title: String type: string nullable: true senderDetail: $ref: '#/components/schemas/TemplateSenderDetails' ccDetails: title: TemplateCC[] type: array items: $ref: '#/components/schemas/TemplateCC' nullable: true createdDate: title: Int64 type: integer format: int64 activityDate: title: Int64 type: integer format: int64 activityBy: title: String type: string nullable: true messageTitle: title: String type: string nullable: true status: title: DocumentStatus enum: - InProgress - Completed - Declined - Expired - Revoked - Draft - Scheduled type: string signerDetails: title: TemplateSignerDetails[] type: array items: $ref: '#/components/schemas/TemplateSignerDetails' nullable: true enableSigningOrder: title: Boolean type: boolean templateName: title: String type: string nullable: true templateDescription: title: String type: string nullable: true accessType: title: TemplateAccessType enum: - Use - Edit - None type: string accessTid: title: String type: string nullable: true isTemplate: title: Boolean type: boolean default: false behalfOf: $ref: '#/components/schemas/BehalfOf' templateLabels: title: List`1 type: array items: title: String type: string nullable: true labels: title: List`1 type: array items: title: String type: string nullable: true brandId: title: String type: string nullable: true additionalProperties: false AuthenticationSettings: title: AuthenticationSettings type: object properties: authenticationFrequency: title: Nullable`1 enum: - None - EveryAccess - UntilSignCompleted - OncePerDocument type: string nullable: true additionalProperties: false EmbeddedTemplateCreated: title: EmbeddedTemplateCreated type: object properties: templateId: title: String type: string nullable: true createUrl: title: Uri type: string format: uri nullable: true additionalProperties: false TemplateFormFields: title: TemplateFormFields type: object properties: id: title: String type: string nullable: true fieldType: title: String type: string nullable: true type: title: String type: string nullable: true value: title: String type: string nullable: true font: title: String type: string nullable: true isRequired: title: Boolean type: boolean isReadOnly: title: Boolean type: boolean lineHeight: title: Int32 type: integer format: int32 fontSize: title: Int32 type: integer format: int32 fontHexColor: title: String type: string nullable: true isUnderLineFont: title: Boolean type: boolean isItalicFont: title: Boolean type: boolean isBoldFont: title: Boolean type: boolean groupName: title: String type: string nullable: true label: title: String type: string nullable: true placeholder: title: String type: string nullable: true validationtype: title: ValidationType enum: - None - NumbersOnly - EmailAddress - Currency - CustomRegex type: string validationCustomRegex: title: String type: string nullable: true validationCustomRegexMessage: title: String type: string nullable: true dateFormat: title: String type: string nullable: true timeFormat: title: String type: string nullable: true imageInfo: $ref: '#/components/schemas/ImageInfo' attachmentInfo: $ref: '#/components/schemas/AttachmentInfo' editableDateFieldSettings: $ref: '#/components/schemas/EditableDateFieldSettings' dropdownOptions: title: String[] type: array items: title: String type: string nullable: true bounds: $ref: '#/components/schemas/Rectangle' pageNumber: title: Int32 type: integer format: int32 conditionalRules: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/ConditionalRule' nullable: true dataSyncTag: title: String type: string nullable: true textAlign: title: TextAlign enum: - Left - Center - Right type: string textDirection: title: TextDirection enum: - LTR - RTL type: string characterSpacing: title: Single type: number format: float characterLimit: title: Int32 type: integer format: int32 hyperlinkText: title: String type: string nullable: true backgroundHexColor: title: String type: string nullable: true tabIndex: title: Int32 type: integer format: int32 formulaFieldSettings: $ref: '#/components/schemas/FormulaFieldSettings' resizeOption: title: Nullable`1 enum: - GrowVertically - GrowHorizontally - GrowBoth - Fixed - AutoResizeFont type: string nullable: true allowEditFormField: title: Boolean type: boolean allowDeleteFormField: title: Boolean type: boolean collaborationSettings: $ref: '#/components/schemas/CollaborationSettings' isMasked: title: Boolean type: boolean default: false isDefaultValueRequired: title: Boolean type: boolean additionalProperties: false TemplateSenderDetail: title: TemplateSenderDetail type: object properties: emailAddress: title: String type: string nullable: true name: title: String type: string nullable: true additionalProperties: false Rectangle: title: Rectangle type: object properties: x: title: Single minimum: 0 type: number format: float default: 0 y: title: Single minimum: 0 type: number format: float default: 0 width: title: Single minimum: 1 type: number format: float default: 1 height: title: Single minimum: 1 type: number format: float default: 1 additionalProperties: false TemplateSharing: title: TemplateSharing type: object properties: teams: title: List`1 type: array items: $ref: '#/components/schemas/TemplateTeamShare' nullable: true additionalProperties: false TemplateCC: title: TemplateCC type: object properties: emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true additionalProperties: false ReminderSettings: title: ReminderSettings type: object properties: enableAutoReminder: title: Boolean type: boolean default: false reminderDays: title: Int32 type: integer format: int32 default: 3 reminderCount: title: Int32 type: integer format: int32 default: 3 additionalProperties: false TemplateRole: title: TemplateRole required: - index type: object properties: name: title: String maxLength: 100 minLength: 0 type: string nullable: true index: title: Int32 maximum: 50 minimum: 1 type: integer format: int32 defaultSignerName: title: String maxLength: 100 minLength: 0 type: string nullable: true defaultSignerEmail: title: String maxLength: 250 minLength: 0 type: string nullable: true signerOrder: title: Int32 type: integer format: int32 signerType: title: SignerType enum: - Signer - Reviewer - InPersonSigner type: string hostEmail: title: String type: string nullable: true language: title: Languages enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 type: integer description:
Description:
Description:
Description:
Description: