openapi: 3.0.3 info: title: BoldSign 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 paths: /v1/brand/create: post: tags: - Branding summary: Create the brand. operationId: CreateBrand requestBody: content: multipart/form-data: schema: required: - BrandLogo - BrandName type: object properties: BrandName: title: String type: string BrandLogo: title: IFormFile type: string format: binary BackgroundColor: title: String type: string ButtonColor: title: String type: string ButtonTextColor: title: String type: string EmailDisplayName: title: String type: string DisclaimerDescription: title: String type: string DisclaimerTitle: title: String type: string RedirectUrl: title: String type: string IsDefault: title: Boolean type: boolean default: false CanHideTagLine: title: Boolean type: boolean default: false CombineAuditTrail: title: Boolean type: boolean default: false CombineAttachments: title: Boolean type: boolean default: false ExcludeAuditTrailFromEmail: title: Boolean type: boolean default: false EmailSignedDocument: title: EmailSignedDocument enum: - Attachment - DocumentLink type: string default: Attachment DocumentTimeZone: title: String type: string ShowBuiltInFormFields: title: Boolean type: boolean default: true AllowCustomFieldCreation: title: Boolean type: boolean default: false ShowSharedCustomFields: title: Boolean type: boolean default: false HideDecline: title: Nullable`1 type: boolean description: This option prevents signers to decline the document during the signing process. HideSave: title: Nullable`1 type: boolean description: This option prevents signers to save their changes during the signing process and continue signing later. DocumentExpirySettings.ExpiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string description: This property represents the type for the expiry date format: Enumeration DocumentExpirySettings.ExpiryValue: title: Nullable`1 type: integer description: This property is used to set the expiry value based on the expiry type format: int32 DocumentExpirySettings.EnableDefaultExpiryAlert: title: Nullable`1 type: boolean description: This property will send the expiry alert email before the day of expiry for the pending signers. DocumentExpirySettings.EnableAutoReminder: title: Nullable`1 type: boolean description: When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders. DocumentExpirySettings.ReminderDays: title: Nullable`1 maximum: 180 minimum: 1 type: integer description: Remind in terms of days. format: int32 DocumentExpirySettings.ReminderCount: title: Nullable`1 type: integer description: Number of reminder count. format: int32 CustomDomainSettings.DomainName: title: String type: string CustomDomainSettings.FromName: title: String type: string SignatureFrameSettings.EnableSignatureFrame: title: Boolean type: boolean default: false SignatureFrameSettings.ShowRecipientName: title: Boolean type: boolean default: false SignatureFrameSettings.ShowRecipientEmail: title: Boolean type: boolean default: false SignatureFrameSettings.ShowTimeStamp: title: Boolean type: boolean default: false encoding: BrandName: style: form BrandLogo: style: form BackgroundColor: style: form ButtonColor: style: form ButtonTextColor: style: form EmailDisplayName: style: form DisclaimerDescription: style: form DisclaimerTitle: style: form RedirectUrl: style: form IsDefault: style: form CanHideTagLine: style: form CombineAuditTrail: style: form CombineAttachments: style: form ExcludeAuditTrailFromEmail: style: form EmailSignedDocument: style: form DocumentTimeZone: style: form ShowBuiltInFormFields: style: form AllowCustomFieldCreation: style: form ShowSharedCustomFields: style: form HideDecline: style: form HideSave: style: form DocumentExpirySettings.ExpiryDateType: style: form DocumentExpirySettings.ExpiryValue: style: form DocumentExpirySettings.EnableDefaultExpiryAlert: style: form DocumentExpirySettings.EnableAutoReminder: style: form DocumentExpirySettings.ReminderDays: style: form DocumentExpirySettings.ReminderCount: style: form CustomDomainSettings.DomainName: style: form CustomDomainSettings.FromName: style: form SignatureFrameSettings.EnableSignatureFrame: style: form SignatureFrameSettings.ShowRecipientName: style: form SignatureFrameSettings.ShowRecipientEmail: style: form SignatureFrameSettings.ShowTimeStamp: style: form responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/xml: schema: $ref: '#/components/schemas/BrandCreated' text/plain: schema: $ref: '#/components/schemas/BrandCreated' application/octet-stream: schema: $ref: '#/components/schemas/BrandCreated' text/json: schema: $ref: '#/components/schemas/BrandCreated' '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' '403': description: Forbidden 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' '422': description: Unprocessable Content 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' /v1/brand/edit: post: tags: - Branding summary: Edit the brand. operationId: EditBrand parameters: - name: brandId in: query required: true schema: title: String type: string requestBody: content: multipart/form-data: schema: type: object properties: BrandName: title: String type: string BrandLogo: title: IFormFile type: string format: binary BackgroundColor: title: String type: string ButtonColor: title: String type: string ButtonTextColor: title: String type: string EmailDisplayName: title: String type: string DisclaimerDescription: title: String type: string DisclaimerTitle: title: String type: string RedirectUrl: title: String type: string IsDefault: title: Boolean type: boolean default: false CanHideTagLine: title: Boolean type: boolean default: false CombineAuditTrail: title: Boolean type: boolean default: false CombineAttachments: title: Boolean type: boolean default: false ExcludeAuditTrailFromEmail: title: Boolean type: boolean default: false EmailSignedDocument: title: EmailSignedDocument enum: - Attachment - DocumentLink type: string default: Attachment DocumentTimeZone: title: String type: string ShowBuiltInFormFields: title: Boolean type: boolean default: true AllowCustomFieldCreation: title: Boolean type: boolean default: false ShowSharedCustomFields: title: Boolean type: boolean default: false HideDecline: title: Nullable`1 type: boolean description: This option prevents signers to decline the document during the signing process. HideSave: title: Nullable`1 type: boolean description: This option prevents signers to save their changes during the signing process and continue signing later. DocumentExpirySettings.ExpiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string description: This property represents the type for the expiry date format: Enumeration DocumentExpirySettings.ExpiryValue: title: Nullable`1 type: integer description: This property is used to set the expiry value based on the expiry type format: int32 DocumentExpirySettings.EnableDefaultExpiryAlert: title: Nullable`1 type: boolean description: This property will send the expiry alert email before the day of expiry for the pending signers. DocumentExpirySettings.EnableAutoReminder: title: Nullable`1 type: boolean description: When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders. DocumentExpirySettings.ReminderDays: title: Nullable`1 maximum: 180 minimum: 1 type: integer description: Remind in terms of days. format: int32 DocumentExpirySettings.ReminderCount: title: Nullable`1 type: integer description: Number of reminder count. format: int32 CustomDomainSettings.DomainName: title: String type: string CustomDomainSettings.FromName: title: String type: string SignatureFrameSettings.EnableSignatureFrame: title: Boolean type: boolean default: false SignatureFrameSettings.ShowRecipientName: title: Boolean type: boolean default: false SignatureFrameSettings.ShowRecipientEmail: title: Boolean type: boolean default: false SignatureFrameSettings.ShowTimeStamp: title: Boolean type: boolean default: false encoding: BrandName: style: form BrandLogo: style: form BackgroundColor: style: form ButtonColor: style: form ButtonTextColor: style: form EmailDisplayName: style: form DisclaimerDescription: style: form DisclaimerTitle: style: form RedirectUrl: style: form IsDefault: style: form CanHideTagLine: style: form CombineAuditTrail: style: form CombineAttachments: style: form ExcludeAuditTrailFromEmail: style: form EmailSignedDocument: style: form DocumentTimeZone: style: form ShowBuiltInFormFields: style: form AllowCustomFieldCreation: style: form ShowSharedCustomFields: style: form HideDecline: style: form HideSave: style: form DocumentExpirySettings.ExpiryDateType: style: form DocumentExpirySettings.ExpiryValue: style: form DocumentExpirySettings.EnableDefaultExpiryAlert: style: form DocumentExpirySettings.EnableAutoReminder: style: form DocumentExpirySettings.ReminderDays: style: form DocumentExpirySettings.ReminderCount: style: form CustomDomainSettings.DomainName: style: form CustomDomainSettings.FromName: style: form SignatureFrameSettings.EnableSignatureFrame: style: form SignatureFrameSettings.ShowRecipientName: style: form SignatureFrameSettings.ShowRecipientEmail: style: form SignatureFrameSettings.ShowTimeStamp: style: form responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCreated' application/json: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCreated' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCreated' application/xml: schema: $ref: '#/components/schemas/BrandCreated' text/plain: schema: $ref: '#/components/schemas/BrandCreated' application/octet-stream: schema: $ref: '#/components/schemas/BrandCreated' text/json: schema: $ref: '#/components/schemas/BrandCreated' '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' '403': description: Forbidden 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' '422': description: Unprocessable Content 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' /v1/brand/get: get: tags: - Branding summary: Get the specific brand details. operationId: GetBrand parameters: - name: brandId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ViewBrandDetails' '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/brand/delete: delete: tags: - Branding summary: Delete the brand. operationId: DeleteBrand parameters: - name: brandId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/xml: schema: $ref: '#/components/schemas/BrandingMessage' text/plain: schema: $ref: '#/components/schemas/BrandingMessage' application/octet-stream: schema: $ref: '#/components/schemas/BrandingMessage' text/json: schema: $ref: '#/components/schemas/BrandingMessage' '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' '403': description: Forbidden 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' /v1/brand/resetdefault: post: tags: - Branding summary: Reset default brand. operationId: ResetDefaultBrand parameters: - name: brandId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandingMessage' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandingMessage' application/xml: schema: $ref: '#/components/schemas/BrandingMessage' text/plain: schema: $ref: '#/components/schemas/BrandingMessage' application/octet-stream: schema: $ref: '#/components/schemas/BrandingMessage' text/json: schema: $ref: '#/components/schemas/BrandingMessage' '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' '403': description: Forbidden 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' /v1/brand/list: get: tags: - Branding summary: List all the brands. operationId: BrandList responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BrandingRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contacts/list: get: tags: - Contacts summary: List Contact document. operationId: ContactUserList parameters: - name: PageSize in: query description: Page size specified in get user contact list request. Default value is 10. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get user contact list request. Default value is 1. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: SearchKey in: query description: Contacts can be listed by the search based on the Name or Email schema: title: String type: string - name: ContactType in: query description: Contact type whether the contact is My Contacts or All Contacts. Default value is AllContacts. schema: title: ContactType enum: - MyContacts - AllContacts type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactsList' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contacts/delete: delete: tags: - Contacts summary: Deletes a contact. operationId: DeleteContacts parameters: - name: id in: query required: true 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/contacts/create: post: tags: - Contacts summary: Create the new Contact. operationId: CreateContact requestBody: description: The contact details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/xml: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' text/plain: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/json-patch+json: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' text/json: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' application/*+json: schema: title: List`1 type: array items: $ref: '#/components/schemas/ContactDetails' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateContactResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contacts/update: put: tags: - Contacts summary: Update the contact. operationId: UpdateContact parameters: - name: id in: query schema: title: String type: string requestBody: description: The contact details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ContactDetails' application/json: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ContactDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ContactDetails' application/xml: schema: $ref: '#/components/schemas/ContactDetails' text/plain: schema: $ref: '#/components/schemas/ContactDetails' application/json-patch+json: schema: $ref: '#/components/schemas/ContactDetails' text/json: schema: $ref: '#/components/schemas/ContactDetails' application/*+json: schema: $ref: '#/components/schemas/ContactDetails' responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contacts/get: get: tags: - Contacts summary: Get summary of the contact. operationId: GetContact parameters: - name: id in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactsDetails' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/customField/create: post: tags: - Custom Field summary: Create the custom field. operationId: CreateCustomField requestBody: description: The custom field details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/xml: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' text/plain: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json-patch+json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' text/json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/*+json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' required: true responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/xml: schema: $ref: '#/components/schemas/CustomFieldMessage' text/plain: schema: $ref: '#/components/schemas/CustomFieldMessage' application/octet-stream: schema: $ref: '#/components/schemas/CustomFieldMessage' text/json: schema: $ref: '#/components/schemas/CustomFieldMessage' '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' '403': description: Forbidden 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' '422': description: Unprocessable Content 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' /v1/customField/edit: post: tags: - Custom Field summary: Edit the custom field. operationId: EditCustomField parameters: - name: customFieldId in: query required: true schema: title: String type: string requestBody: description: The custom field details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/xml: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' text/plain: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/json-patch+json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' text/json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' application/*+json: schema: $ref: '#/components/schemas/BrandCustomFieldDetails' required: true responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CustomFieldMessage' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CustomFieldMessage' application/xml: schema: $ref: '#/components/schemas/CustomFieldMessage' text/plain: schema: $ref: '#/components/schemas/CustomFieldMessage' application/octet-stream: schema: $ref: '#/components/schemas/CustomFieldMessage' text/json: schema: $ref: '#/components/schemas/CustomFieldMessage' '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' '403': description: Forbidden 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' '422': description: Unprocessable Content 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' /v1/customField/delete: delete: tags: - Custom Field summary: Delete the custom field. operationId: DeleteCustomField parameters: - name: customFieldId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/xml: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' text/plain: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' application/octet-stream: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' text/json: schema: $ref: '#/components/schemas/DeleteCustomFieldReply' '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' '403': description: Forbidden 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' '422': description: Unprocessable Content 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' /v1/customField/list: get: tags: - Custom Field summary: List the custom fields respective to the brand id. operationId: CustomFieldsList parameters: - name: brandId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CustomFieldCollection' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/customField/createEmbeddedCustomFieldUrl: post: tags: - Custom Field summary: Generates a URL for creating or modifying custom fields within your application's embedded Designer. operationId: EmbedCustomField parameters: - name: BrandId in: query description: The Brand ID for custom fields must be configured required: true schema: title: String type: string - name: LinkValidTill in: query description: This property is used to set the validity of the generated URL. Its maximum validity is 30 days schema: title: Nullable`1 type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmbeddedCustomFieldCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/send: post: tags: - Document summary: Sends the document for sign. operationId: SendDocument requestBody: description: The send for sign request body. content: application/json: schema: $ref: '#/components/schemas/SendForSign' multipart/form-data: schema: $ref: '#/components/schemas/SendForSign' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendForSign' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DocumentCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/extendExpiry: patch: tags: - Document summary: Extends the expiration date of the document. operationId: ExtendExpiry parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ExtendExpiry' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ExtendExpiry' application/xml: schema: $ref: '#/components/schemas/ExtendExpiry' text/plain: schema: $ref: '#/components/schemas/ExtendExpiry' application/json-patch+json: schema: $ref: '#/components/schemas/ExtendExpiry' text/json: schema: $ref: '#/components/schemas/ExtendExpiry' application/*+json: schema: $ref: '#/components/schemas/ExtendExpiry' 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' '403': description: Forbidden 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' /v1/document/createEmbeddedRequestUrl: post: tags: - Document summary: Generates a send URL which embeds document sending process into your application. operationId: CreateEmbeddedRequestUrlDocument requestBody: description: The embedded send document request body. content: application/json: schema: $ref: '#/components/schemas/EmbeddedDocumentRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedDocumentRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedDocumentRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedSendCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/createEmbeddedEditUrl: post: tags: - Document summary: Generates an embedded edit URL that allows the document editing process to be integrated into your application. operationId: createEmbeddedEditUrl parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: The embedded edit document request body. content: application/json: schema: $ref: '#/components/schemas/EmbeddedDocumentEditJsonRequest' multipart/form-data: schema: $ref: '#/components/schemas/EmbeddedDocumentEditJsonRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EmbeddedDocumentEditJsonRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmbeddedDocumentEdited' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '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/document/list: get: tags: - Document summary: List user documents. operationId: ListDocuments parameters: - name: SentBy in: query schema: title: List`1 type: array items: title: String type: string - name: Recipients in: query schema: title: List`1 type: array items: title: String type: string - name: TransmitType in: query schema: title: TransmitType enum: - Sent - Received - Both type: string - name: DateFilterType in: query description: Date Filter as SentBetween and ExpiresOn. schema: title: DateFilterType enum: - SentBetween - Expiring type: string - name: PageSize in: query description: Page size specified in get document list request. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get document list request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: StartDate in: query description: Start date of the document schema: title: Nullable`1 type: string format: date-time - name: Status in: query description: Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. schema: title: List`1 type: array items: title: Status enum: - None - WaitingForMe - WaitingForOthers - NeedAttention - Completed - Declined - Revoked - Expired - Draft - Scheduled type: string - name: EndDate in: query description: End date of the document schema: title: Nullable`1 type: string format: date-time - name: SearchKey in: query description: Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., schema: title: String type: string - name: Labels in: query description: Labels of the document. schema: title: IEnumerable`1 type: array items: title: String type: string - name: NextCursor in: query description: Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. schema: title: Nullable`1 type: integer format: int64 - name: BrandIds in: query description: BrandId(s) of the document. schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/teamlist: get: tags: - Document summary: Get user Team documents. operationId: TeamDocuments parameters: - name: UserId in: query description: UserId of the Team document. schema: title: List`1 type: array items: title: String type: string - name: TeamId in: query description: TeamId of the Team document. schema: title: List`1 type: array items: title: String type: string - name: TransmitType in: query description: Transmit type as Sent, Received and Both. schema: title: TransmitType enum: - Sent - Received - Both type: string - name: DateFilterType in: query description: Date Filter as SentBetween and Expiring. schema: title: DateFilterType enum: - SentBetween - Expiring type: string - name: PageSize in: query description: Page size specified in get document list request. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get document list request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: StartDate in: query description: Start date of the document schema: title: Nullable`1 type: string format: date-time - name: Status in: query description: Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. schema: title: List`1 type: array items: title: Status enum: - None - WaitingForMe - WaitingForOthers - NeedAttention - Completed - Declined - Revoked - Expired - Draft - Scheduled type: string - name: EndDate in: query description: End date of the document schema: title: Nullable`1 type: string format: date-time - name: SearchKey in: query description: Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., schema: title: String type: string - name: Labels in: query description: Labels of the document. schema: title: IEnumerable`1 type: array items: title: String type: string - name: NextCursor in: query description: Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. schema: title: Nullable`1 type: integer format: int64 - name: BrandIds in: query description: BrandId(s) of the document. schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamDocumentRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/behalfList: get: tags: - Document summary: Gets the behalf documents. operationId: BehalfDocuments parameters: - name: PageType in: query description: The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. schema: title: PageType enum: - BehalfOfOthers - BehalfOfMe type: string - name: EmailAddress in: query description: The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. schema: title: List`1 type: array items: title: String type: string - name: Signers in: query description: A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list schema: title: List`1 type: array items: title: String type: string - name: PageSize in: query description: Page size specified in get document list request. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get document list request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: StartDate in: query description: Start date of the document schema: title: Nullable`1 type: string format: date-time - name: Status in: query description: Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. schema: title: List`1 type: array items: title: Status enum: - None - WaitingForMe - WaitingForOthers - NeedAttention - Completed - Declined - Revoked - Expired - Draft - Scheduled type: string - name: EndDate in: query description: End date of the document schema: title: Nullable`1 type: string format: date-time - name: SearchKey in: query description: Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., schema: title: String type: string - name: Labels in: query description: Labels of the document. schema: title: IEnumerable`1 type: array items: title: String type: string - name: NextCursor in: query description: Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. schema: title: Nullable`1 type: integer format: int64 - name: BrandIds in: query description: BrandId(s) of the document. schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BehalfDocumentRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/properties: get: tags: - Document summary: Get summary of the document. operationId: GetDocumentProperties parameters: - name: documentId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentProperties' '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/document/download: get: tags: - Document summary: Download the document. operationId: DownloadDocument parameters: - name: documentId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/xml: schema: title: FileStreamResult type: string format: binary text/plain: schema: title: FileStreamResult type: string format: binary application/octet-stream: schema: title: FileStreamResult type: string format: binary text/json: schema: title: FileStreamResult type: string format: binary '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' '403': description: Forbidden 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' /v1/document/downloadAttachment: get: tags: - Document summary: Download the Attachment. operationId: DownloadAttachment parameters: - name: documentId in: query required: true schema: title: String type: string - name: attachmentId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/xml: schema: title: FileStreamResult type: string format: binary text/plain: schema: title: FileStreamResult type: string format: binary application/octet-stream: schema: title: FileStreamResult type: string format: binary text/json: schema: title: FileStreamResult type: string format: binary '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' '403': description: Forbidden 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' /v1/document/downloadAuditLog: get: tags: - Document summary: Download the audit trail document. operationId: DownloadAuditLog parameters: - name: documentId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/xml: schema: title: FileStreamResult type: string format: binary text/plain: schema: title: FileStreamResult type: string format: binary application/octet-stream: schema: title: FileStreamResult type: string format: binary text/json: schema: title: FileStreamResult type: string format: binary '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' '403': description: Forbidden 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' /v1/document/revoke: post: tags: - Document summary: Revoke the document. operationId: RevokeDocument parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: RevokeDetails. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RevokeDocument' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RevokeDocument' application/xml: schema: $ref: '#/components/schemas/RevokeDocument' text/plain: schema: $ref: '#/components/schemas/RevokeDocument' application/json-patch+json: schema: $ref: '#/components/schemas/RevokeDocument' text/json: schema: $ref: '#/components/schemas/RevokeDocument' application/*+json: schema: $ref: '#/components/schemas/RevokeDocument' required: true 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/document/delete: delete: tags: - Document summary: Delete the document. operationId: DeleteDocument parameters: - name: documentId in: query required: true schema: title: String type: string - name: deletePermanently in: query schema: title: Boolean type: boolean default: false responses: '204': description: No Content '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' '403': description: Forbidden 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' /v1/document/remind: post: tags: - Document summary: Send reminder to pending signers. operationId: RemindDocument parameters: - name: documentId in: query required: true schema: title: String type: string - name: receiverEmails in: query schema: title: String[] type: array items: title: String type: string requestBody: description: Reminder Message for signers. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ReminderMessage' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ReminderMessage' application/xml: schema: $ref: '#/components/schemas/ReminderMessage' text/plain: schema: $ref: '#/components/schemas/ReminderMessage' application/json-patch+json: schema: $ref: '#/components/schemas/ReminderMessage' text/json: schema: $ref: '#/components/schemas/ReminderMessage' application/*+json: schema: $ref: '#/components/schemas/ReminderMessage' responses: '204': description: No Content '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' '403': description: Forbidden 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' /v1/document/changeAccessCode: patch: tags: - Document summary: Changes the access code for the given document signer. operationId: ChangeAccessCode parameters: - name: DocumentId in: query required: true schema: title: String type: string - name: EmailId in: query schema: title: String type: string - name: ZOrder in: query schema: title: Nullable`1 type: integer format: int32 requestBody: description: The new access code. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetails' application/xml: schema: $ref: '#/components/schemas/AccessCodeDetails' text/plain: schema: $ref: '#/components/schemas/AccessCodeDetails' application/json-patch+json: schema: $ref: '#/components/schemas/AccessCodeDetails' text/json: schema: $ref: '#/components/schemas/AccessCodeDetails' application/*+json: schema: $ref: '#/components/schemas/AccessCodeDetails' required: true responses: '204': description: No Content '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' '403': description: Forbidden 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' /v1/document/changeRecipient: patch: tags: - Document summary: Change recipient details of a document. operationId: ChangeRecipient parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: The new recipient details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeRecipient' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeRecipient' application/xml: schema: $ref: '#/components/schemas/ChangeRecipient' text/plain: schema: $ref: '#/components/schemas/ChangeRecipient' application/json-patch+json: schema: $ref: '#/components/schemas/ChangeRecipient' text/json: schema: $ref: '#/components/schemas/ChangeRecipient' application/*+json: schema: $ref: '#/components/schemas/ChangeRecipient' required: true responses: '204': description: No Content '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' '403': description: Forbidden 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' /v1/document/getEmbeddedSignLink: get: tags: - Document summary: Get sign link for Embedded Sign. operationId: GetEmbeddedSignLink parameters: - name: DocumentId in: query required: true schema: title: String type: string - name: SignerEmail in: query schema: title: String type: string - name: CountryCode in: query schema: title: String type: string - name: PhoneNumber in: query schema: title: String type: string - name: SignLinkValidTill in: query schema: title: Nullable`1 type: string format: date-time - name: RedirectUrl in: query schema: title: Uri type: string format: uri responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/xml: schema: $ref: '#/components/schemas/EmbeddedSigningLink' text/plain: schema: $ref: '#/components/schemas/EmbeddedSigningLink' application/octet-stream: schema: $ref: '#/components/schemas/EmbeddedSigningLink' text/json: schema: $ref: '#/components/schemas/EmbeddedSigningLink' '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' '403': description: Forbidden 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' /v1/document/addTags: patch: tags: - Document summary: Add the Tags in Documents. operationId: AddDocumentTag requestBody: description: Contains DocumentId and LabelNames for Adding Tags. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/xml: schema: $ref: '#/components/schemas/DocumentTags' text/plain: schema: $ref: '#/components/schemas/DocumentTags' application/json-patch+json: schema: $ref: '#/components/schemas/DocumentTags' text/json: schema: $ref: '#/components/schemas/DocumentTags' application/*+json: schema: $ref: '#/components/schemas/DocumentTags' 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/document/deleteTags: delete: tags: - Document summary: Delete the Tags in Documents. operationId: DeleteDocumentTag requestBody: description: Contains DocumentId and LabelNames for Adding Tags. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/DocumentTags' application/json: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DocumentTags' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DocumentTags' application/xml: schema: $ref: '#/components/schemas/DocumentTags' text/plain: schema: $ref: '#/components/schemas/DocumentTags' application/json-patch+json: schema: $ref: '#/components/schemas/DocumentTags' text/json: schema: $ref: '#/components/schemas/DocumentTags' application/*+json: schema: $ref: '#/components/schemas/DocumentTags' 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/document/RemoveAuthentication: patch: tags: - Document summary: Remove the access code for the given document signer. operationId: RemoveAuthentication parameters: - name: DocumentId in: query description: Document ID of the signature request required: true schema: title: String type: string requestBody: description: To remove access code. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/RemoveAuthentication' application/xml: schema: $ref: '#/components/schemas/RemoveAuthentication' text/plain: schema: $ref: '#/components/schemas/RemoveAuthentication' application/json-patch+json: schema: $ref: '#/components/schemas/RemoveAuthentication' text/json: schema: $ref: '#/components/schemas/RemoveAuthentication' application/*+json: schema: $ref: '#/components/schemas/RemoveAuthentication' responses: '204': description: No Content '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' '403': description: Forbidden 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' /v1/document/addAuthentication: patch: tags: - Document summary: The add authentication to recipient. operationId: AddAuthentication parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: Access code details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/AccessCodeDetail' application/xml: schema: $ref: '#/components/schemas/AccessCodeDetail' text/plain: schema: $ref: '#/components/schemas/AccessCodeDetail' application/json-patch+json: schema: $ref: '#/components/schemas/AccessCodeDetail' text/json: schema: $ref: '#/components/schemas/AccessCodeDetail' application/*+json: schema: $ref: '#/components/schemas/AccessCodeDetail' responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/prefillFields: patch: tags: - Document summary: Updates the value (prefill) of the fields in the document. operationId: PrefillFields parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: The prefill field request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/xml: schema: $ref: '#/components/schemas/PrefillFieldRequest' text/plain: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/json-patch+json: schema: $ref: '#/components/schemas/PrefillFieldRequest' text/json: schema: $ref: '#/components/schemas/PrefillFieldRequest' application/*+json: schema: $ref: '#/components/schemas/PrefillFieldRequest' required: true responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/draftSend: post: tags: - Document summary: Sends a draft-status document out for signature. operationId: DraftSend parameters: - name: documentId in: query required: true schema: title: String type: string responses: '201': description: Created '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/edit: put: tags: - Document summary: Edit and updates an existing document. operationId: EditDocument parameters: - name: documentId in: query required: true schema: title: String type: string requestBody: description: Edit document JSON request. content: application/json: schema: $ref: '#/components/schemas/EditDocumentRequest' multipart/form-data: schema: $ref: '#/components/schemas/EditDocumentRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EditDocumentRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentEdited' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/document/cancelEditing: post: tags: - Document summary: Cancels editing for a document that is currently in edit-mode. operationId: cancelEditing parameters: - name: documentId in: query required: true schema: title: String type: string - name: onBehalfOf in: query schema: title: String type: string responses: '200': description: OK '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contactGroups/list: get: tags: - GroupContacts summary: List Group Contacts. operationId: GroupContactList parameters: - name: PageSize in: query description: Page size specified in get user group contact list request. Default value is 10. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get user group contact list request. Default value is 1. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: SearchKey in: query description: Group Contacts can be listed by the search based on the Name or Email schema: title: String type: string - name: ContactType in: query description: Group Contact type whether the contact is my contacts or all contacts. Default value is AllContacts. schema: title: ContactType enum: - MyContacts - AllContacts type: string - name: Directories in: query description: Group Contacts can be listed by the search based on the directories schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupContactsList' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contactGroups/create: post: tags: - GroupContacts summary: Create a new Group Contact. operationId: CreateGroupContact requestBody: description: The group contact details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/GroupContactDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/GroupContactDetails' application/xml: schema: $ref: '#/components/schemas/GroupContactDetails' text/plain: schema: $ref: '#/components/schemas/GroupContactDetails' application/json-patch+json: schema: $ref: '#/components/schemas/GroupContactDetails' text/json: schema: $ref: '#/components/schemas/GroupContactDetails' application/*+json: schema: $ref: '#/components/schemas/GroupContactDetails' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateGroupContactResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contactGroups/update: put: tags: - GroupContacts summary: Update the Group Contact. operationId: UpdateGroupContact parameters: - name: groupId in: query required: true schema: title: String type: string requestBody: description: The group contact details. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateGroupContact' application/xml: schema: $ref: '#/components/schemas/UpdateGroupContact' text/plain: schema: $ref: '#/components/schemas/UpdateGroupContact' application/json-patch+json: schema: $ref: '#/components/schemas/UpdateGroupContact' text/json: schema: $ref: '#/components/schemas/UpdateGroupContact' application/*+json: schema: $ref: '#/components/schemas/UpdateGroupContact' required: true responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contactGroups/get: get: tags: - GroupContacts summary: Get Summary of the Group Contact. operationId: GetGroupContact parameters: - name: groupId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetGroupContactDetails' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/contactGroups/delete: delete: tags: - GroupContacts summary: Deletes a Group Contact. operationId: DeleteGroupContact parameters: - name: groupId in: query required: true 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/identityVerification/report: post: tags: - Identity Verification summary: Retrieve the ID verification report for the specified document signer. operationId: Report parameters: - name: documentId in: query required: true schema: title: Guid type: string format: uuid requestBody: description: The download image request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/VerificationDataRequest' application/xml: schema: $ref: '#/components/schemas/VerificationDataRequest' text/plain: schema: $ref: '#/components/schemas/VerificationDataRequest' application/json-patch+json: schema: $ref: '#/components/schemas/VerificationDataRequest' text/json: schema: $ref: '#/components/schemas/VerificationDataRequest' application/*+json: schema: $ref: '#/components/schemas/VerificationDataRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdReport' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/identityVerification/image: post: tags: - Identity Verification summary: Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID. operationId: Image parameters: - name: documentId in: query required: true schema: title: Guid type: string format: uuid requestBody: description: The download image request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/DownloadImageRequest' application/xml: schema: $ref: '#/components/schemas/DownloadImageRequest' text/plain: schema: $ref: '#/components/schemas/DownloadImageRequest' application/json-patch+json: schema: $ref: '#/components/schemas/DownloadImageRequest' text/json: schema: $ref: '#/components/schemas/DownloadImageRequest' application/*+json: schema: $ref: '#/components/schemas/DownloadImageRequest' required: true responses: '200': description: OK content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false: schema: title: FileStreamResult type: string format: binary application/json: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=false: schema: title: FileStreamResult type: string format: binary application/json;IEEE754Compatible=true: schema: title: FileStreamResult type: string format: binary application/xml: schema: title: FileStreamResult type: string format: binary text/plain: schema: title: FileStreamResult type: string format: binary application/octet-stream: schema: title: FileStreamResult type: string format: binary text/json: schema: title: FileStreamResult type: string format: binary '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' '403': description: Forbidden 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' /v1/identityVerification/createEmbeddedVerificationUrl: post: tags: - Identity Verification summary: Generate a URL that embeds manual ID verification for the specified document signer into your application. operationId: Create Embedded Verification Url parameters: - name: documentId in: query required: true schema: title: Guid type: string format: uuid requestBody: description: The embedded verification link request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/xml: schema: $ref: '#/components/schemas/EmbeddedFileDetails' text/plain: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/json-patch+json: schema: $ref: '#/components/schemas/EmbeddedFileDetails' text/json: schema: $ref: '#/components/schemas/EmbeddedFileDetails' application/*+json: schema: $ref: '#/components/schemas/EmbeddedFileDetails' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmbeddedFileLink' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/plan/apiCreditsCount: get: tags: - Plan summary: Gets the Api credits details. operationId: ApiCreditsCount responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingViewModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/senderIdentities/create: post: tags: - Sender Identities summary: Creates sender identity. operationId: CreateSenderIdentities requestBody: description: The create sender identity request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/xml: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' text/plain: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/json-patch+json: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' text/json: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' application/*+json: schema: $ref: '#/components/schemas/CreateSenderIdentityRequest' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SenderIdentityCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/senderIdentities/update: post: tags: - Sender Identities summary: Updates sender identity. operationId: UpdateSenderIdentities parameters: - name: email in: query required: true schema: title: String type: string requestBody: description: The create sender identity request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/xml: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' text/plain: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/json-patch+json: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' text/json: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' application/*+json: schema: $ref: '#/components/schemas/EditSenderIdentityRequest' required: true 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/senderIdentities/delete: delete: tags: - Sender Identities summary: Deletes sender identity. operationId: DeleteSenderIdentities parameters: - name: email in: query required: true 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/senderIdentities/resendInvitation: post: tags: - Sender Identities summary: Resends sender identity invitation. operationId: ResendInvitationSenderIdentities parameters: - name: email in: query required: true 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/senderIdentities/rerequest: post: tags: - Sender Identities summary: Rerequests denied sender identity. operationId: ReRequestSenderIdentities parameters: - name: email in: query required: true 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/senderIdentities/list: get: tags: - Sender Identities summary: Lists sender identity. operationId: ListSenderIdentities parameters: - name: PageSize in: query description: Page size specified in get sender identity list request. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get sender identity request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: Search in: query description: Users can be listed by the search key present in the sender identity like sender identity name and email address schema: title: String type: string - name: BrandIds in: query description: A list of brand IDs to filter associated with the sender identity. schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SenderIdentityList' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/senderIdentities/properties: get: tags: - Sender Identities summary: Gets sender identity by ID or email. operationId: GetSenderIdentityProperties parameters: - name: id in: query schema: title: String type: string - name: email in: query schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SenderIdentityViewModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/teams/get: get: tags: - Teams summary: Get Team details. operationId: GetTeam parameters: - name: teamId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/teams/list: get: tags: - Teams summary: List Teams. operationId: ListTeams parameters: - name: Page in: query description: Page index specified in get team list request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: PageSize in: query description: Page size specified in get team list request. schema: title: Int32 type: integer format: int32 default: 10 - name: SearchKey in: query description: Teams can be listed by the search key schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamListResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/teams/create: post: tags: - Teams summary: Create Team. operationId: CreateTeam requestBody: description: team creation. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/CreateTeamRequest' application/xml: schema: $ref: '#/components/schemas/CreateTeamRequest' text/plain: schema: $ref: '#/components/schemas/CreateTeamRequest' application/json-patch+json: schema: $ref: '#/components/schemas/CreateTeamRequest' text/json: schema: $ref: '#/components/schemas/CreateTeamRequest' application/*+json: schema: $ref: '#/components/schemas/CreateTeamRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamCreated' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/teams/update: put: tags: - Teams summary: Update Team. operationId: UpdateTeam requestBody: description: update team. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/xml: schema: $ref: '#/components/schemas/TeamUpdateRequest' text/plain: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/json-patch+json: schema: $ref: '#/components/schemas/TeamUpdateRequest' text/json: schema: $ref: '#/components/schemas/TeamUpdateRequest' application/*+json: schema: $ref: '#/components/schemas/TeamUpdateRequest' required: true responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /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' /v1/users/create: post: tags: - User summary: Create the user. operationId: CreateUser requestBody: description: The create user. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=full;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.metadata=none;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=true;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=true;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=false;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;odata.streaming=false;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;IEEE754Compatible=false: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json;IEEE754Compatible=true: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/xml: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' text/plain: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/json-patch+json: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' text/json: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' application/*+json: schema: title: List`1 type: array items: $ref: '#/components/schemas/CreateUser' 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/users/update: put: tags: - User summary: Update new User role. operationId: UpdateUser requestBody: description: update query. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUser' application/json: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUser' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUser' application/xml: schema: $ref: '#/components/schemas/UpdateUser' text/plain: schema: $ref: '#/components/schemas/UpdateUser' application/json-patch+json: schema: $ref: '#/components/schemas/UpdateUser' text/json: schema: $ref: '#/components/schemas/UpdateUser' application/*+json: schema: $ref: '#/components/schemas/UpdateUser' responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/resendInvitation: post: tags: - User summary: Resend the users invitation. operationId: ResendInvitation parameters: - name: UserId in: query required: true schema: title: String type: string responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/cancelInvitation: post: tags: - User summary: Cancel the users invitation. operationId: CancelInvitation parameters: - name: UserId in: query required: true schema: title: String type: string responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/list: get: tags: - User summary: List user documents. operationId: ListUsers parameters: - name: PageSize in: query description: Page size specified in get user list request. schema: title: Int32 type: integer format: int32 default: 10 - name: Page in: query description: Page index specified in get user list request. required: true schema: title: Int32 type: integer format: int32 default: 1 - name: Search in: query description: Users can be listed by the search based on the user ID schema: title: String type: string - name: UserId in: query description: Users can be listed by the search based on the user IDs schema: title: List`1 type: array items: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserRecords' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/get: get: tags: - User summary: Get summary of the user. operationId: GetUser parameters: - name: userId in: query required: true schema: title: String type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserProperties' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/updateMetaData: put: tags: - User summary: Update new User meta data details. operationId: updateMetaData requestBody: description: update query. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/xml: schema: $ref: '#/components/schemas/UpdateUserMetaData' text/plain: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/json-patch+json: schema: $ref: '#/components/schemas/UpdateUserMetaData' text/json: schema: $ref: '#/components/schemas/UpdateUserMetaData' application/*+json: schema: $ref: '#/components/schemas/UpdateUserMetaData' responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' /v1/users/changeTeam: put: tags: - User summary: Change users to other team. operationId: ChangeTeam parameters: - name: userId in: query required: true schema: title: String type: string requestBody: description: Change team request. content: application/json;odata.metadata=minimal;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=full;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.metadata=none;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=true;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=true;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=false;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;odata.streaming=false;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;IEEE754Compatible=false: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json;IEEE754Compatible=true: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/xml: schema: $ref: '#/components/schemas/ChangeTeamRequest' text/plain: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/json-patch+json: schema: $ref: '#/components/schemas/ChangeTeamRequest' text/json: schema: $ref: '#/components/schemas/ChangeTeamRequest' application/*+json: schema: $ref: '#/components/schemas/ChangeTeamRequest' responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' components: schemas: AccessCodeDetail: title: AccessCodeDetail required: - authenticationType type: object properties: emailId: title: String type: string nullable: true order: title: Nullable`1 maximum: 50 minimum: 1 type: integer format: int32 nullable: true accessCode: title: String type: string nullable: true authenticationType: title: Nullable`1 enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string onBehalfOf: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' identityVerificationSettings: $ref: '#/components/schemas/IdentityVerificationSettings' authenticationRetryCount: title: Nullable`1 maximum: 10 minimum: 1 type: integer format: int32 nullable: true authenticationSettings: $ref: '#/components/schemas/AuthenticationSettings' additionalProperties: false AccessCodeDetails: title: AccessCodeDetails required: - accessCode type: object properties: accessCode: title: String minLength: 1 type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' onBehalfOf: title: String type: string nullable: true additionalProperties: false Added: title: Added type: object properties: signerName: title: String type: string nullable: true signerEmail: title: String type: string nullable: true signerPhoneNumber: title: String type: string nullable: true additionalProperties: false Address: title: Address type: object properties: city: title: String type: string nullable: true country: title: String type: string nullable: true line1: title: String type: string nullable: true line2: title: String type: string nullable: true postalCode: title: String type: string nullable: true state: title: String type: string nullable: true additionalProperties: false AttachmentInfo: title: AttachmentInfo required: - acceptedFileTypes - title type: object properties: title: title: String type: string nullable: true description: title: String type: string nullable: true allowedFileTypes: title: String type: string nullable: true deprecated: true acceptedFileTypes: title: String[] type: array items: title: String type: string nullable: true additionalProperties: false AuditTrail: title: AuditTrail type: object properties: id: title: String type: string nullable: true name: title: String type: string nullable: true email: title: String type: string nullable: true fromName: title: String type: string nullable: true fromEmail: title: String type: string nullable: true fromPhoneNumber: title: String type: string nullable: true toName: title: String type: string nullable: true toEmail: title: String type: string nullable: true toPhoneNumber: title: String type: string nullable: true ipaddress: title: String type: string nullable: true action: title: DocumentAuditAction enum: - Sent - Viewed - Signed - Completed - Downloaded - Reassigned - Declined - Recalled - Created - AuthenticationFailed - Reminder - AccessCodeChanged - AccessCodeViewed - DownloadedForPrintSign - FormCreated - EmailOTP - AuthenticationRemoved - DownloadedAuditTrail - Cloned - ClonedWithFieldValues - Deleted - MovedToTrash - Restored - AutoReminder - Resend - Reviewed - InitiatePrintSign - CancelPrintSign - CompletePrintSign - GeneratedEmbeddedSignLink - EmbeddedSigned - EmbeddedReviewed - ExpiryDateExtended - Attachment - EditRecipient - AuthenticationAdded - AutoReminderON - AutoReminderOFF - SMSOTP - PhoneNumberChanged - UnlockedSMSOTP - SMSAuthenticationAdded - SMSAuthenticationRemoved - SMSOTPVerified - SMSAuthenticationFailed - UnlockEmailOTP - EmailAuthenticationAdded - EmailAuthenticationRemoved - EmailOtpVerify - EmailAuthenticationFailed - SMSOTPResend - EmailOTPResend - ResumeDocumentSigning - EmailOTPAuthenticationAdded - EmailOTPAuthenticationRemoved - EmailOTPAuthenticationFailed - EmailOTPVerified - IdentityVerificationInitiated - IdentityVerificationRemoved - IdentityVerificationCompleted - IdentityVerificationFailed - DownloadedVerificationData - ManualIdentityVerificationCompleted - IdentityVerificationReset - CreateEmbeddedVerificationLink - SensitiveDataDownloaded - IdVerificationRemoved - IdVerificationAdded - ManualIdentityVerificationInitiated - GeneratedSigningLink - EditingInitiated - EditingCancelled - EditingCompleted - QESVerificationInitiated - QESVerified - QESRejected - QESExpired - QESWithdrawn - ResentForApproval - DocumentFieldMarkup type: string timestamp: title: Int64 type: integer format: int64 recipientChangeLog: $ref: '#/components/schemas/RecipientChangeLog' documentChangeLog: $ref: '#/components/schemas/ModificationDetails' fieldChangeLog: $ref: '#/components/schemas/ModificationDetails' additionalProperties: false AuthenticationSettings: title: AuthenticationSettings type: object properties: authenticationFrequency: title: Nullable`1 enum: - None - EveryAccess - UntilSignCompleted - OncePerDocument type: string nullable: true additionalProperties: false Base64File: title: Base64File required: - base64 type: object properties: base64: title: String minLength: 1 type: string fileName: title: String type: string nullable: true additionalProperties: false BehalfDocument: title: BehalfDocument type: object properties: behalfOf: $ref: '#/components/schemas/BehalfOf' documentId: title: String type: string nullable: true senderDetail: $ref: '#/components/schemas/DocumentSenderDetail' ccDetails: title: DocumentCcDetails[] type: array items: $ref: '#/components/schemas/DocumentCcDetails' 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: DocumentSignerDetails[] type: array items: $ref: '#/components/schemas/DocumentSignerDetails' nullable: true expiryDate: title: Int64 type: integer format: int64 enableSigningOrder: title: Boolean type: boolean isDeleted: title: Boolean type: boolean labels: title: List`1 type: array items: title: String type: string nullable: true cursor: title: Int64 type: integer format: int64 brandId: title: String type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true inEditingMode: title: Boolean type: boolean displayStatus: title: String type: string nullable: true additionalProperties: false BehalfDocumentRecords: title: BehalfDocumentRecords type: object properties: pageDetails: $ref: '#/components/schemas/PageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/BehalfDocument' nullable: true additionalProperties: false BehalfOf: title: BehalfOf type: object properties: name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true additionalProperties: false BehalfOfWebhookModel: title: BehalfOfWebhookModel type: object properties: id: title: String type: string nullable: true email: title: String type: string nullable: true additionalProperties: false BillingViewModel: title: BillingViewModel type: object properties: BalanceCredits: title: Double type: number format: double additionalProperties: false BrandCreated: title: BrandCreated type: object properties: brandId: title: String type: string nullable: true additionalProperties: false BrandCustomFieldDetails: title: BrandCustomFieldDetails type: object properties: fieldName: title: String type: string nullable: true fieldDescription: title: String type: string nullable: true fieldOrder: title: Int32 type: integer format: int32 default: 1 brandId: title: String type: string nullable: true sharedField: title: Boolean type: boolean formField: $ref: '#/components/schemas/CustomFormField' additionalProperties: false BrandingMessage: title: BrandingMessage type: object properties: message: title: String type: string nullable: true additionalProperties: false BrandingRecords: title: BrandingRecords type: object properties: result: title: List`1 type: array items: $ref: '#/components/schemas/ViewBrandDetails' nullable: true additionalProperties: false ChangeRecipient: title: ChangeRecipient required: - newSignerName - reason type: object properties: newSignerName: title: String minLength: 1 type: string reason: title: String minLength: 1 type: string order: title: Nullable`1 maximum: 50 minimum: 1 type: integer format: int32 nullable: true newSignerEmail: title: String type: string format: email nullable: true oldSignerEmail: title: String type: string format: email nullable: true onBehalfOf: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' oldPhoneNumber: $ref: '#/components/schemas/PhoneNumber' additionalProperties: false ChangeTeamRequest: title: ChangeTeamRequest required: - toTeamId type: object properties: toTeamId: title: String minLength: 1 type: string transferDocumentsToUserId: title: String type: string nullable: true additionalProperties: false CollaborationSettings: title: CollaborationSettings type: object properties: isRequired: title: Nullable`1 type: boolean nullable: true requireSignerApproval: title: Nullable`1 type: boolean nullable: true requireInitial: title: Nullable`1 type: boolean nullable: true allowedSigners: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false ConditionalRule: title: ConditionalRule type: object properties: fieldId: title: String type: string nullable: true isChecked: title: Boolean type: boolean value: title: String type: string nullable: true additionalProperties: false ContactCreated: title: ContactCreated type: object properties: id: title: String type: string nullable: true email: title: String type: string nullable: true additionalProperties: false ContactDetails: title: ContactDetails required: - email - name type: object properties: email: title: String minLength: 1 type: string name: title: String minLength: 1 type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' jobTitle: title: String type: string nullable: true companyName: title: String type: string nullable: true additionalProperties: false ContactPageDetails: title: ContactPageDetails type: object properties: pageSize: title: Int32 type: integer format: int32 page: title: Int32 type: integer format: int32 totalRecordsCount: title: Int32 type: integer format: int32 additionalProperties: false ContactsDetails: title: ContactsDetails type: object properties: id: title: String type: string nullable: true name: title: String type: string nullable: true email: title: String type: string nullable: true companyName: title: String type: string nullable: true jobTitle: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' additionalProperties: false ContactsList: title: ContactsList type: object properties: pageDetails: $ref: '#/components/schemas/ContactPageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/ContactsDetails' nullable: true additionalProperties: false CreateContactResponse: title: CreateContactResponse type: object properties: createdContacts: title: List`1 type: array items: $ref: '#/components/schemas/ContactCreated' nullable: true additionalProperties: false CreateGroupContactResponse: title: CreateGroupContactResponse type: object properties: groupId: title: String type: string nullable: true groupName: title: String type: string nullable: true additionalProperties: false CreateSenderIdentityRequest: title: CreateSenderIdentityRequest required: - email type: object properties: name: title: String maxLength: 80 minLength: 0 type: string nullable: true email: title: String maxLength: 250 minLength: 0 type: string notificationSettings: $ref: '#/components/schemas/NotificationSettings' brandId: title: String type: string nullable: true redirectUrl: title: Uri type: string format: uri nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string additionalProperties: false CreateTeamRequest: title: CreateTeamRequest required: - teamName type: object properties: teamName: title: String maxLength: 255 minLength: 0 type: string additionalProperties: false CreateTemplateRequest: title: CreateTemplateRequest required: - title type: object properties: title: title: String maxLength: 256 minLength: 0 type: string description: title: String maxLength: 5000 minLength: 0 type: string nullable: true documentTitle: title: String maxLength: 256 minLength: 0 type: string nullable: true documentMessage: title: String maxLength: 5000 minLength: 0 type: string nullable: true files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true roles: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateRole' nullable: true allowModifyFiles: title: Boolean type: boolean default: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true brandId: title: String type: string nullable: true allowMessageEditing: title: Boolean type: boolean default: true allowNewRoles: title: Boolean type: boolean default: true allowNewFiles: title: Boolean type: boolean default: true enableReassign: title: Boolean type: boolean default: true enablePrintAndSign: title: Boolean type: boolean default: false enableSigningOrder: title: Boolean type: boolean default: false documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true useTextTags: title: Boolean type: boolean default: false textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true autoDetectFields: title: Boolean type: boolean default: false onBehalfOf: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true templateLabels: title: IEnumerable`1 type: array items: title: String type: string nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true formFieldPermission: $ref: '#/components/schemas/FormFieldPermission' groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false CreateUser: title: CreateUser required: - emailId type: object properties: emailId: title: String minLength: 1 type: string teamId: title: String type: string nullable: true userRole: title: UserRoleType enum: - Admin - TeamAdmin - Member type: string metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true additionalProperties: false Creators: title: Creators type: object properties: userId: title: String type: string nullable: true createdBy: title: String type: string nullable: true additionalProperties: false CustomDomainSettings: title: CustomDomainSettings type: object properties: domainName: title: String type: string nullable: true fromName: title: String type: string nullable: true additionalProperties: false CustomFieldCollection: title: CustomFieldCollection type: object properties: result: title: List`1 type: array items: $ref: '#/components/schemas/ViewCustomFieldDetails' nullable: true additionalProperties: false CustomFieldMessage: title: CustomFieldMessage type: object properties: customFieldId: title: String type: string nullable: true message: title: String type: string nullable: true additionalProperties: false CustomFormField: title: CustomFormField required: - fieldType type: object properties: fieldType: title: FieldType enum: - Signature - Initial - CheckBox - TextBox - Label - DateSigned - RadioButton - Image - Attachment - EditableDate - Hyperlink - Dropdown - Title - Company - Formula - Drawing type: string width: title: Single type: number format: float height: title: Single type: number format: float 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 default: 13 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 default: 15 characterLimit: title: Int32 maximum: 2147483647 minimum: 0 type: integer format: int32 default: 0 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 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 idPrefix: title: String type: string nullable: true restrictIdPrefixChange: title: Boolean type: boolean default: false backgroundHexColor: title: String type: string nullable: true resizeOption: title: Nullable`1 enum: - GrowVertically - GrowHorizontally - GrowBoth - Fixed - AutoResizeFont type: string nullable: true isMasked: title: Nullable`1 type: boolean default: false nullable: true additionalProperties: false Date: title: Date type: object properties: day: title: Nullable`1 type: integer format: int64 nullable: true month: title: Nullable`1 type: integer format: int64 nullable: true year: title: Nullable`1 type: integer format: int64 nullable: true additionalProperties: false DeleteCustomFieldReply: title: DeleteCustomFieldReply type: object properties: message: title: String type: string nullable: true additionalProperties: false Document: title: Document type: object properties: documentId: title: String type: string nullable: true senderDetail: $ref: '#/components/schemas/DocumentSenderDetail' ccDetails: title: DocumentCcDetails[] type: array items: $ref: '#/components/schemas/DocumentCcDetails' 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: DocumentSignerDetails[] type: array items: $ref: '#/components/schemas/DocumentSignerDetails' nullable: true expiryDate: title: Int64 type: integer format: int64 enableSigningOrder: title: Boolean type: boolean isDeleted: title: Boolean type: boolean labels: title: List`1 type: array items: title: String type: string nullable: true cursor: title: Int64 type: integer format: int64 brandId: title: String type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true inEditingMode: title: Boolean type: boolean displayStatus: 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 DocumentCcDetails: title: DocumentCcDetails type: object properties: emailAddress: title: String type: string nullable: true isViewed: title: Boolean type: boolean default: false additionalProperties: false DocumentCcWebhookModel: title: DocumentCcWebhookModel type: object properties: emailAddress: title: String type: string nullable: true id: title: String type: string nullable: true additionalProperties: false DocumentCreated: title: DocumentCreated type: object properties: documentId: title: String type: string nullable: true additionalProperties: false DocumentEdited: title: DocumentEdited type: object properties: status: title: EditProcessStatus enum: - Completed - Queued type: string additionalProperties: false DocumentEvent: title: DocumentEvent type: object properties: object: title: String type: string nullable: true documentId: title: String type: string nullable: true messageTitle: title: String type: string nullable: true documentDescription: title: String type: string nullable: true status: title: DocumentStatus enum: - InProgress - Completed - Declined - Expired - Revoked - Draft - Scheduled type: string senderDetail: $ref: '#/components/schemas/DocumentSender' signerDetails: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentSignerWebhookModel' nullable: true ccDetails: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCcWebhookModel' nullable: true onBehalfOf: title: String type: string nullable: true createdDate: title: Nullable`1 type: string format: date-time nullable: true expiryDate: title: Nullable`1 type: string format: date-time nullable: true enableSigningOrder: title: Boolean type: boolean disableEmails: title: Boolean type: boolean revokeMessage: title: String type: string nullable: true errorMessage: title: String type: string nullable: true labels: title: List`1 type: array items: title: String type: string nullable: true isCombinedAudit: title: Boolean type: boolean isCombinedAttachment: title: Boolean type: boolean BrandId: title: String type: string nullable: true documentDownloadOption: title: String type: string nullable: true metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true failedDeliveryMode: title: Nullable`1 enum: - Email - SMS - WhatsApp type: string nullable: true behalfOf: $ref: '#/components/schemas/BehalfOfWebhookModel' allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettingsWebhookModel' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false DocumentExpirySettings: title: DocumentExpirySettings type: object properties: expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string format: Enumeration nullable: true expiryValue: title: Nullable`1 type: integer format: int32 nullable: true enableDefaultExpiryAlert: title: Nullable`1 type: boolean nullable: true enableAutoReminder: title: Nullable`1 type: boolean nullable: true reminderDays: title: Nullable`1 maximum: 180 minimum: 1 type: integer format: int32 nullable: true reminderCount: title: Nullable`1 type: integer format: int32 nullable: true additionalProperties: false DocumentFiles: title: DocumentFiles type: object properties: id: title: String type: string nullable: true documentName: title: String type: string nullable: true order: title: Int32 type: integer format: int32 pageCount: title: Int32 type: integer format: int32 templateName: title: String type: string nullable: true templateId: title: String type: string nullable: true additionalProperties: false DocumentFormFields: title: DocumentFormFields type: object properties: id: title: String type: string nullable: true formFieldId: 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: Single type: number format: float fontSize: title: Single type: number format: float fontColor: title: String type: string nullable: true isUnderline: title: Boolean type: boolean isItalic: title: Boolean type: boolean isBold: 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' fileInfo: $ref: '#/components/schemas/FileInfo' 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 bounds: $ref: '#/components/schemas/Rectangle' pageNumber: title: Int32 type: integer format: int32 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: 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' hidden: title: Boolean type: boolean isMasked: title: Boolean type: boolean default: false additionalProperties: false DocumentGroupSignerWebhookModel: title: DocumentGroupSignerWebhookModel type: object properties: id: title: String type: string nullable: true signerEmail: title: String type: string nullable: true signerName: title: String type: string nullable: true status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string isViewed: title: Boolean type: boolean isDeliveryFailed: title: Boolean type: boolean isAuthenticationFailed: title: Nullable`1 type: boolean nullable: true lastReminderSentOn: title: Nullable`1 type: string format: date-time nullable: true additionalProperties: false DocumentInfo: title: DocumentInfo required: - locale - title type: object properties: 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string title: title: String minLength: 1 type: string description: title: String type: string nullable: true additionalProperties: false DocumentProperties: title: DocumentProperties type: object properties: documentId: title: String type: string nullable: true brandId: title: String type: string nullable: true messageTitle: title: String type: string nullable: true documentDescription: title: String type: string nullable: true status: title: DocumentStatus enum: - InProgress - Completed - Declined - Expired - Revoked - Draft - Scheduled type: string files: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentFiles' nullable: true senderDetail: $ref: '#/components/schemas/DocumentSenderDetail' signerDetails: title: DocumentSignerDetails[] type: array items: $ref: '#/components/schemas/DocumentSignerDetails' nullable: true formGroups: title: FormGroup[] type: array items: $ref: '#/components/schemas/FormGroup' nullable: true commonFields: title: DocumentFormFields[] type: array items: $ref: '#/components/schemas/DocumentFormFields' nullable: true behalfOf: $ref: '#/components/schemas/BehalfOf' ccDetails: title: DocumentCcDetails[] type: array items: $ref: '#/components/schemas/DocumentCcDetails' nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' reassign: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentReassign' nullable: true documentHistory: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/AuditTrail' nullable: true activityBy: title: String type: string nullable: true activityDate: title: Int64 type: integer format: int64 activityAction: title: ActivityAction enum: - Viewed - Signed - Reassigned - Declined - Revoked - Expired - Downloaded - DownloadedForPrintSign - InitiatePrintAndSign - InitiateFormSign - CancelPrintAndSign - CompletePrintAndSign - Reviewed - None - EditingInitiated - EditingCancelled - EditingCompleted - DocumentScheduled type: string createdDate: title: Int64 type: integer format: int64 expiryDays: title: Int32 type: integer format: int32 expiryDate: title: Nullable`1 type: integer format: int64 nullable: true enableSigningOrder: title: Boolean type: boolean isDeleted: title: Boolean type: boolean revokeMessage: title: String type: string nullable: true declineMessage: title: String type: string nullable: true applicationId: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableEmails: title: Boolean type: boolean enablePrintAndSign: title: Boolean type: boolean enableReassign: title: Boolean type: boolean disableExpiryAlert: title: Boolean type: boolean hideDocumentId: title: Boolean type: boolean expiryDateType: title: ExpiryDateType enum: - Days - Hours - SpecificDateTime type: string expiryValue: title: Int64 type: integer format: int64 documentDownloadOption: title: DocumentDownloadOption enum: - Combined - Individually type: string metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Boolean type: boolean downloadFileName: title: String type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' inEditingMode: title: Boolean type: boolean displayStatus: title: String type: string nullable: true enableAllowSignEverywhere: title: Boolean type: boolean isCombinedAudit: title: Boolean type: boolean isCombinedAttachment: title: Boolean type: boolean documentTimeZone: title: String type: string nullable: true additionalProperties: false DocumentReassign: title: DocumentReassign type: object properties: signerEmail: title: String type: string nullable: true order: title: Int32 type: integer format: int32 default: 0 message: title: String type: string nullable: true additionalProperties: false DocumentRecords: title: DocumentRecords type: object properties: pageDetails: $ref: '#/components/schemas/PageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/Document' nullable: true additionalProperties: false DocumentSender: title: DocumentSender type: object properties: name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true teamId: title: String type: string nullable: true additionalProperties: false DocumentSenderDetail: title: DocumentSenderDetail type: object properties: name: title: String type: string nullable: true privateMessage: title: String type: string nullable: true emailAddress: title: String type: string nullable: true isViewed: title: Boolean type: boolean default: false additionalProperties: false DocumentSigner: title: DocumentSigner type: object properties: id: title: String type: string nullable: true name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true privateMessage: title: String maxLength: 5000 type: string nullable: true authenticationType: title: AuthenticationType enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string authenticationCode: title: String maxLength: 50 type: string nullable: true identityVerificationSettings: $ref: '#/components/schemas/IdentityVerificationSettings' signerOrder: title: Int32 type: integer format: int32 enableEmailOTP: title: Boolean type: boolean signerType: title: SignerType enum: - Signer - Reviewer - InPersonSigner type: string hostEmail: title: String type: string nullable: true signerRole: title: String type: string nullable: true allowFieldConfiguration: title: Boolean type: boolean formFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/FormField' 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string signType: title: SignType enum: - Single - Group type: string groupId: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' authenticationRetryCount: title: Nullable`1 maximum: 10 minimum: 1 type: integer format: int32 nullable: true enableQes: title: Nullable`1 type: boolean nullable: true authenticationSettings: $ref: '#/components/schemas/AuthenticationSettings' additionalProperties: false DocumentSignerDetails: title: DocumentSignerDetails type: object properties: id: title: String type: string nullable: true signerName: title: String type: string nullable: true signerRole: title: String type: string nullable: true signerEmail: title: String type: string nullable: true status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string enableAccessCode: title: Boolean type: boolean isAuthenticationFailed: title: Nullable`1 type: boolean default: false nullable: true enableEmailOTP: title: Boolean type: boolean authenticationType: title: AuthenticationType enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string isDeliveryFailed: title: Boolean type: boolean default: false isViewed: title: Boolean type: boolean default: false order: title: Int32 type: integer format: int32 default: 0 signerType: title: SignerType enum: - Signer - Reviewer - InPersonSigner type: string default: Signer hostEmail: title: String type: string nullable: true hostName: title: String type: string nullable: true isReassigned: title: Boolean type: boolean privateMessage: title: String type: string nullable: true allowFieldConfiguration: title: Boolean type: boolean formFields: title: DocumentFormFields[] type: array items: $ref: '#/components/schemas/DocumentFormFields' 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string signType: title: SignType enum: - Single - Group type: string default: Single groupId: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' idVerification: $ref: '#/components/schemas/IdVerificationDetails' recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' authenticationRetryCount: title: Nullable`1 type: integer format: int32 nullable: true enableQes: title: Nullable`1 type: boolean nullable: true deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string authenticationSettings: $ref: '#/components/schemas/SignerAuthenticationSettings' groupSigners: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/GroupSigner' nullable: true additionalProperties: false DocumentSignerWebhookModel: title: DocumentSignerWebhookModel type: object properties: signerName: title: String type: string nullable: true signerRole: title: String type: string nullable: true signerEmail: title: String type: string nullable: true id: title: String type: string nullable: true groupSigners: title: List`1 type: array items: $ref: '#/components/schemas/DocumentGroupSignerWebhookModel' nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumberWebhookModel' status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string enableAccessCode: title: Boolean type: boolean isAuthenticationFailed: title: Nullable`1 type: boolean nullable: true enableEmailOTP: title: Boolean type: boolean isDeliveryFailed: title: Boolean type: boolean isViewed: title: Boolean type: boolean order: title: Int32 type: integer format: int32 signerType: title: String type: string nullable: true signType: title: String type: string nullable: true groupId: title: String type: string nullable: true isReassigned: title: Boolean type: boolean reassignMessage: title: String type: string nullable: true declineMessage: title: String type: string nullable: true lastActivityDate: title: Nullable`1 type: string format: date-time nullable: true authenticationType: title: String type: string nullable: true idVerification: $ref: '#/components/schemas/IdVerificationSignerWebhookModel' allowFieldConfiguration: title: Boolean type: boolean lastReminderSentOn: title: Nullable`1 type: string format: date-time nullable: true authenticationRetryCount: title: Nullable`1 type: integer format: int32 nullable: true authenticationSettings: $ref: '#/components/schemas/SignerAuthenticationWebhookModel' additionalProperties: false DocumentTags: title: DocumentTags required: - documentId - tags type: object properties: documentId: title: String minLength: 1 type: string tags: title: List`1 type: array items: title: String type: string additionalProperties: false DownloadImageRequest: title: DownloadImageRequest type: object properties: emailId: title: String type: string nullable: true countryCode: title: String type: string nullable: true phoneNumber: title: String type: string nullable: true order: title: Int32 type: integer format: int32 fileId: title: String type: string nullable: true onBehalfOf: title: String type: string nullable: true additionalProperties: false EditDocumentFile: title: EditDocumentFile required: - editAction type: object properties: editAction: title: Nullable`1 enum: - Add - Update - Remove type: string file: title: IFormFile type: string format: binary nullable: true fileUrl: title: Uri type: string format: uri nullable: true id: title: String type: string nullable: true additionalProperties: false EditDocumentJsonFile: title: EditDocumentJsonFile required: - editAction type: object properties: file: $ref: '#/components/schemas/Base64File' editAction: title: Nullable`1 enum: - Add - Update - Remove type: string fileUrl: title: Uri type: string format: uri nullable: true id: title: String type: string nullable: true additionalProperties: false EditDocumentRequest: title: EditDocumentRequest type: object properties: files: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/EditDocumentFile' nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true signers: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/EditDocumentSigner' nullable: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Nullable`1 type: integer format: int64 nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' disableEmails: title: Nullable`1 type: boolean nullable: true disableSMS: title: Nullable`1 type: boolean nullable: true brandId: title: String type: string nullable: true hideDocumentId: title: Nullable`1 type: boolean nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true enablePrintAndSign: title: Nullable`1 type: boolean nullable: true enableReassign: title: Nullable`1 type: boolean nullable: true useTextTags: title: Boolean type: boolean textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EditDocumentSigner: title: EditDocumentSigner required: - editAction type: object properties: editAction: title: Nullable`1 enum: - Add - Update - Remove type: string id: title: String type: string nullable: true name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true privateMessage: title: String maxLength: 5000 type: string nullable: true authenticationType: title: Nullable`1 enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' deliveryMode: title: Nullable`1 enum: - Email - SMS - EmailAndSMS - WhatsApp type: string nullable: true authenticationCode: title: String maxLength: 50 type: string nullable: true identityVerificationSettings: $ref: '#/components/schemas/IdentityVerificationSettings' signerOrder: title: Nullable`1 type: integer format: int32 nullable: true enableEmailOTP: title: Nullable`1 type: boolean nullable: true signerType: title: Nullable`1 enum: - Signer - Reviewer - InPersonSigner type: string nullable: true hostEmail: title: String type: string nullable: true signerRole: title: String type: string nullable: true allowFieldConfiguration: title: Nullable`1 type: boolean nullable: true formFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/EditFormField' nullable: true language: title: Nullable`1 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 type: integer format: int32 nullable: true locale: title: Nullable`1 enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string nullable: true signType: title: Nullable`1 enum: - Single - Group type: string nullable: true groupId: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' authenticationRetryCount: title: Nullable`1 maximum: 10 minimum: 1 type: integer format: int32 nullable: true enableQes: title: Nullable`1 type: boolean nullable: true authenticationSettings: $ref: '#/components/schemas/AuthenticationSettings' additionalProperties: false EditFormField: title: EditFormField required: - editAction type: object properties: editAction: title: Nullable`1 enum: - Add - Update - Remove type: string id: title: String type: string nullable: true name: title: String type: string nullable: true fieldType: title: Nullable`1 enum: - Signature - Initial - CheckBox - TextBox - Label - DateSigned - RadioButton - Image - Attachment - EditableDate - Hyperlink - Dropdown - Title - Company - Formula - Drawing type: string nullable: true pageNumber: title: Nullable`1 type: integer format: int32 nullable: true bounds: $ref: '#/components/schemas/Rectangle' isRequired: title: Nullable`1 type: boolean nullable: true value: title: String type: string nullable: true fontSize: title: Nullable`1 minimum: 0 type: number format: float nullable: true font: title: Nullable`1 enum: - Helvetica - Courier - TimesRoman - NotoSans - Carlito type: string nullable: true fontHexColor: title: String type: string nullable: true isBoldFont: title: Nullable`1 type: boolean nullable: true isItalicFont: title: Nullable`1 type: boolean nullable: true isUnderLineFont: title: Nullable`1 type: boolean nullable: true lineHeight: title: Nullable`1 maximum: 2147483647 minimum: 0 type: integer format: int32 nullable: true characterLimit: title: Nullable`1 maximum: 2147483647 minimum: 0 type: integer format: int32 nullable: true groupName: title: String type: string nullable: true label: title: String type: string nullable: true placeHolder: title: String type: string nullable: true validationType: title: Nullable`1 enum: - None - NumbersOnly - EmailAddress - Currency - CustomRegex type: string nullable: true 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' conditionalRules: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/ConditionalRule' nullable: true hyperlinkText: title: String type: string nullable: true dropdownOptions: title: String[] type: array items: title: String type: string nullable: true isReadOnly: title: Nullable`1 type: boolean nullable: true dataSyncTag: title: String type: string nullable: true textAlign: title: Nullable`1 enum: - Left - Center - Right type: string nullable: true textDirection: title: Nullable`1 enum: - LTR - RTL type: string nullable: true characterSpacing: title: Nullable`1 type: number format: float nullable: true backgroundHexColor: title: String type: string nullable: true tabIndex: title: Nullable`1 maximum: 2147483647 minimum: -1 type: integer format: int32 nullable: true readOnly: 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 isMasked: title: Nullable`1 type: boolean default: false nullable: true additionalProperties: false EditSenderIdentityRequest: title: EditSenderIdentityRequest type: object properties: name: title: String maxLength: 80 minLength: 0 type: string nullable: true notificationSettings: $ref: '#/components/schemas/NotificationSettings' redirectUrl: title: Uri type: string format: uri nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true locale: title: Nullable`1 enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string nullable: true additionalProperties: false EditTemplateRequest: title: EditTemplateRequest type: object properties: title: title: String maxLength: 256 minLength: 0 type: string nullable: true description: title: String maxLength: 5000 minLength: 0 type: string nullable: true documentTitle: title: String maxLength: 256 minLength: 0 type: string nullable: true documentMessage: title: String maxLength: 5000 minLength: 0 type: string nullable: true roles: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateRole' nullable: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true brandId: title: String type: string nullable: true allowMessageEditing: title: Nullable`1 type: boolean nullable: true allowNewRoles: title: Nullable`1 type: boolean nullable: true allowNewFiles: title: Nullable`1 type: boolean nullable: true allowModifyFiles: title: Nullable`1 type: boolean nullable: true enableReassign: title: Nullable`1 type: boolean nullable: true enablePrintAndSign: title: Nullable`1 type: boolean nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true templateLabels: title: IEnumerable`1 type: array items: title: String type: string nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true formFieldPermission: $ref: '#/components/schemas/FormFieldPermission' groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EditableDateFieldSettings: title: EditableDateFieldSettings required: - dateFormat type: object properties: dateFormat: title: String type: string nullable: true minDate: title: Nullable`1 type: string format: date-time nullable: true maxDate: title: Nullable`1 type: string format: date-time nullable: true timeFormat: title: String type: string nullable: true additionalProperties: false EmbeddedCreateTemplateRequest: title: EmbeddedCreateTemplateRequest required: - title type: object properties: redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean default: false viewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string default: PreparePage showSaveButton: title: Boolean type: boolean default: true locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string default: EN showSendButton: title: Nullable`1 type: boolean nullable: true deprecated: true showCreateButton: title: Boolean type: boolean default: true showPreviewButton: title: Boolean type: boolean default: true showNavigationButtons: title: Boolean type: boolean default: true linkValidTill: title: Nullable`1 type: string format: date-time nullable: true showTooltip: title: Boolean type: boolean default: false title: title: String maxLength: 256 minLength: 0 type: string description: title: String maxLength: 5000 minLength: 0 type: string nullable: true documentTitle: title: String maxLength: 256 minLength: 0 type: string nullable: true documentMessage: title: String maxLength: 5000 minLength: 0 type: string nullable: true files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true roles: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateRole' nullable: true allowModifyFiles: title: Boolean type: boolean default: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true brandId: title: String type: string nullable: true allowMessageEditing: title: Boolean type: boolean default: true allowNewRoles: title: Boolean type: boolean default: true allowNewFiles: title: Boolean type: boolean default: true enableReassign: title: Boolean type: boolean default: true enablePrintAndSign: title: Boolean type: boolean default: false enableSigningOrder: title: Boolean type: boolean default: false documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true useTextTags: title: Boolean type: boolean default: false textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true autoDetectFields: title: Boolean type: boolean default: false onBehalfOf: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true templateLabels: title: IEnumerable`1 type: array items: title: String type: string nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true formFieldPermission: $ref: '#/components/schemas/FormFieldPermission' groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EmbeddedCustomFieldCreated: title: EmbeddedCustomFieldCreated type: object properties: createUrl: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedDocumentEditJsonRequest: title: EmbeddedDocumentEditJsonRequest type: object properties: redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean default: false sendViewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string default: PreparePage locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string default: EN showSendButton: title: Boolean type: boolean default: true showPreviewButton: title: Boolean type: boolean default: true showNavigationButtons: title: Boolean type: boolean default: true linkValidTill: title: Nullable`1 type: string format: date-time nullable: true onBehalfOf: title: String type: string nullable: true additionalProperties: false EmbeddedDocumentEdited: title: EmbeddedDocumentEdited type: object properties: editUrl: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedDocumentRequest: title: EmbeddedDocumentRequest type: object properties: redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean default: false sendViewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string default: PreparePage showSaveButton: title: Boolean type: boolean default: true locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string default: EN showSendButton: title: Boolean type: boolean default: true showPreviewButton: title: Boolean type: boolean default: true showNavigationButtons: title: Boolean type: boolean default: true showTooltip: title: Boolean type: boolean default: false embeddedSendLinkValidTill: title: Nullable`1 type: string format: date-time nullable: true files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true signers: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentSigner' nullable: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true enableSigningOrder: title: Boolean type: boolean default: false expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 reminderSettings: $ref: '#/components/schemas/ReminderSettings' enableEmbeddedSigning: title: Boolean type: boolean default: false deprecated: true disableEmails: title: Boolean type: boolean default: false disableSMS: title: Boolean type: boolean default: false brandId: title: String type: string nullable: true hideDocumentId: title: Nullable`1 type: boolean default: false nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true sendLinkValidTill: title: Nullable`1 type: string format: date-time nullable: true useTextTags: title: Boolean type: boolean default: false textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true enablePrintAndSign: title: Boolean type: boolean default: false enableReassign: title: Boolean type: boolean default: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true AutoDetectFields: title: Boolean type: boolean default: false documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EmbeddedFileDetails: title: EmbeddedFileDetails type: object properties: emailId: title: String type: string nullable: true countryCode: title: String type: string nullable: true phoneNumber: title: String type: string nullable: true redirectUrl: title: String type: string nullable: true order: title: Int32 type: integer format: int32 onBehalfOf: title: String type: string nullable: true additionalProperties: false EmbeddedFileLink: title: EmbeddedFileLink type: object properties: url: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedMergeTemplateFormRequest: title: EmbeddedMergeTemplateFormRequest type: object properties: files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean sendViewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string showSaveButton: title: Boolean type: boolean locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string showSendButton: title: Boolean type: boolean showPreviewButton: title: Boolean type: boolean showNavigationButtons: title: Boolean type: boolean sendLinkValidTill: title: Nullable`1 type: string format: date-time nullable: true showTooltip: title: Boolean type: boolean templateIds: title: String[] type: array items: title: String type: string nullable: true useTextTags: title: Boolean type: boolean textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true documentId: title: String type: string nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true roles: title: List`1 type: array items: $ref: '#/components/schemas/Role' nullable: true brandId: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableEmails: title: Boolean type: boolean disableSMS: title: Boolean type: boolean default: false hideDocumentId: title: Nullable`1 type: boolean nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 enablePrintAndSign: title: Boolean type: boolean enableReassign: title: Nullable`1 type: boolean nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true roleRemovalIndices: title: Int32[] type: array items: title: Int32 type: integer format: int32 nullable: true documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true removeFormFields: title: List`1 type: array items: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EmbeddedSendCreated: title: EmbeddedSendCreated type: object properties: documentId: title: String type: string nullable: true sendUrl: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedSendTemplateFormRequest: title: EmbeddedSendTemplateFormRequest type: object properties: files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean sendViewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string showSaveButton: title: Boolean type: boolean locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string showSendButton: title: Boolean type: boolean showPreviewButton: title: Boolean type: boolean showNavigationButtons: title: Boolean type: boolean sendLinkValidTill: title: Nullable`1 type: string format: date-time nullable: true showTooltip: title: Boolean type: boolean documentId: title: String type: string nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true roles: title: List`1 type: array items: $ref: '#/components/schemas/Role' nullable: true brandId: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableEmails: title: Boolean type: boolean disableSMS: title: Boolean type: boolean default: false hideDocumentId: title: Nullable`1 type: boolean nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 enablePrintAndSign: title: Boolean type: boolean enableReassign: title: Nullable`1 type: boolean nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true roleRemovalIndices: title: Int32[] type: array items: title: Int32 type: integer format: int32 nullable: true documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true removeFormFields: title: List`1 type: array items: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false EmbeddedSigningLink: title: EmbeddedSigningLink type: object properties: signLink: title: Uri type: string format: uri 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 EmbeddedTemplateEditRequest: title: EmbeddedTemplateEditRequest type: object properties: redirectUrl: title: Uri type: string format: uri nullable: true showToolbar: title: Boolean type: boolean default: false viewOption: title: PageViewOption enum: - PreparePage - FillingPage type: string default: PreparePage showSaveButton: title: Boolean type: boolean default: true locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string default: EN showCreateButton: title: Boolean type: boolean default: true showPreviewButton: title: Boolean type: boolean default: true showNavigationButtons: title: Boolean type: boolean default: true linkValidTill: title: Nullable`1 type: string format: date-time nullable: true showTooltip: title: Boolean type: boolean default: false onBehalfOf: title: String type: string nullable: true additionalProperties: false EmbeddedTemplateEdited: title: EmbeddedTemplateEdited type: object properties: editUrl: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedTemplatePreview: title: EmbeddedTemplatePreview type: object properties: templateUrl: title: Uri type: string format: uri nullable: true additionalProperties: false EmbeddedTemplatePreviewJsonRequest: title: EmbeddedTemplatePreviewJsonRequest type: object properties: linkValidTill: title: Nullable`1 type: string format: date-time nullable: true showToolbar: title: Boolean type: boolean additionalProperties: false Error: title: Error type: object properties: code: title: String type: string nullable: true message: title: String type: string nullable: true additionalProperties: false ErrorResponse: title: ErrorResponse type: object properties: errorType: title: String type: string nullable: true error: title: String type: string nullable: true additionalProperties: false ErrorResult: title: ErrorResult type: object properties: error: title: String type: string nullable: true additionalProperties: false ExistingFormField: title: ExistingFormField type: object properties: index: title: Int32 type: integer format: int32 name: title: String type: string nullable: true deprecated: true id: title: String type: string nullable: true value: title: String type: string nullable: true isReadOnly: title: Nullable`1 type: boolean nullable: true additionalProperties: false ExtendExpiry: title: ExtendExpiry type: object properties: newExpiryValue: title: String type: string nullable: true newExpiryDate: title: String type: string nullable: true deprecated: true warnPrior: title: Nullable`1 type: boolean nullable: true onBehalfOf: title: String type: string nullable: true additionalProperties: false FileInfo: title: FileInfo type: object properties: fileName: title: String type: string nullable: true fileSize: title: Int32 type: integer format: int32 contentType: title: String type: string nullable: true extension: title: String type: string nullable: true additionalProperties: false Font: title: Font type: object properties: name: title: Nullable`1 enum: - Helvetica - Courier - TimesRoman - NotoSans - Carlito type: string nullable: true color: title: String type: string nullable: true size: title: Nullable`1 type: number format: float nullable: true style: title: Nullable`1 enum: - Regular - Bold - Italic - Underline type: string nullable: true deprecated: true lineHeight: title: Nullable`1 type: integer format: int32 nullable: true isBoldFont: title: Boolean type: boolean isItalicFont: title: Boolean type: boolean isUnderLineFont: title: Boolean type: boolean 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 FormFieldPermission: title: FormFieldPermission type: object properties: canAdd: title: Boolean type: boolean canModify: title: Boolean type: boolean canModifyDefaultValue: title: Boolean type: boolean additionalProperties: false FormFieldPermissionWebhookModel: title: FormFieldPermissionWebhookModel type: object properties: canAdd: title: Boolean type: boolean canModify: title: Boolean type: boolean canModifyDefaultValue: title: Boolean type: boolean additionalProperties: false FormGroup: title: FormGroup required: - groupNames - groupValidation type: object properties: minimumCount: title: Nullable`1 maximum: 2147483647 minimum: 0 type: integer format: int32 nullable: true maximumCount: title: Nullable`1 maximum: 2147483647 minimum: 0 type: integer format: int32 nullable: true dataSyncTag: title: String type: string nullable: true groupNames: title: IEnumerable`1 type: array items: title: String type: string groupValidation: title: GroupValidation enum: - Minimum - Maximum - Absolute - Range type: string format: Enumeration additionalProperties: false FormulaFieldSettings: title: FormulaFieldSettings type: object properties: formulaExpression: title: String type: string nullable: true decimalPrecision: title: Int32 type: integer format: int32 default: 0 additionalProperties: false GetGroupContactDetails: title: GetGroupContactDetails type: object properties: groupName: title: String type: string nullable: true groupId: title: String type: string nullable: true contacts: title: List`1 type: array items: $ref: '#/components/schemas/GroupUser' nullable: true creator: $ref: '#/components/schemas/Creators' directories: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false GroupContact: title: GroupContact type: object properties: groupName: title: String type: string nullable: true groupId: title: String type: string nullable: true contacts: title: List`1 type: array items: $ref: '#/components/schemas/GroupUser' nullable: true directories: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false GroupContactDetails: title: GroupContactDetails required: - contacts - groupName type: object properties: groupName: title: String minLength: 1 type: string directories: title: List`1 type: array items: title: String type: string nullable: true contacts: title: List`1 type: array items: $ref: '#/components/schemas/GroupUser' additionalProperties: false GroupContactsList: title: GroupContactsList type: object properties: pageDetails: $ref: '#/components/schemas/ContactPageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/GroupContact' nullable: true additionalProperties: false GroupSigner: title: GroupSigner type: object properties: id: title: String type: string nullable: true signerEmail: title: String type: string nullable: true signerName: title: String type: string nullable: true status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string isViewed: title: Boolean type: boolean isDeliveryFailed: title: Boolean type: boolean isAuthenticationFailed: title: Nullable`1 type: boolean nullable: true additionalProperties: false GroupSignerSettings: title: GroupSignerSettings type: object properties: enabled: title: Boolean type: boolean allowedDirectories: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false GroupSignerSettingsWebhookModel: title: GroupSignerSettingsWebhookModel type: object properties: enabled: title: Boolean type: boolean allowedDirectories: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false GroupUser: title: GroupUser required: - email - name type: object properties: name: title: String minLength: 1 type: string email: title: String minLength: 1 type: string additionalProperties: false IdDocument: title: IdDocument type: object properties: type: title: String type: string nullable: true firstName: title: String type: string nullable: true lastName: title: String type: string nullable: true country: title: String type: string nullable: true documentNumber: title: String type: string nullable: true address: $ref: '#/components/schemas/Address' dob: $ref: '#/components/schemas/Date' issuedDate: $ref: '#/components/schemas/Date' expirationDate: $ref: '#/components/schemas/Date' documentFiles: title: List`1 type: array items: title: String type: string nullable: true selfieFile: title: String type: string nullable: true additionalProperties: false IdReport: title: IdReport type: object properties: verificationResult: title: String type: string nullable: true verifiedDate: title: Nullable`1 type: string format: date-time nullable: true error: $ref: '#/components/schemas/Error' document: $ref: '#/components/schemas/IdDocument' additionalProperties: false IdVerificationDetails: title: IdVerificationDetails type: object properties: type: title: String type: string nullable: true maximumRetryCount: title: Nullable`1 type: integer format: int32 nullable: true status: title: String type: string nullable: true nameMatcher: title: String type: string nullable: true requireLiveCapture: title: Nullable`1 type: boolean nullable: true requireMatchingSelfie: title: Nullable`1 type: boolean nullable: true holdForPrefill: title: Nullable`1 type: boolean nullable: true prefillCompleted: title: Nullable`1 type: boolean nullable: true allowedDocumentTypes: title: List`1 type: array items: title: String type: string nullable: true allowedCountries: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false IdVerificationSignerWebhookModel: title: IdVerificationSignerWebhookModel type: object properties: type: title: String type: string nullable: true maximumRetryCount: title: Nullable`1 type: integer format: int32 nullable: true status: title: String type: string nullable: true nameMatcher: title: String type: string nullable: true requireLiveCapture: title: Nullable`1 type: boolean nullable: true requireMatchingSelfie: title: Nullable`1 type: boolean nullable: true holdForPrefill: title: Nullable`1 type: boolean nullable: true prefillCompleted: title: Nullable`1 type: boolean nullable: true allowedDocumentTypes: title: List`1 type: array items: title: String type: string nullable: true additionalProperties: false IdentityVerificationEvent: title: IdentityVerificationEvent type: object properties: object: title: String type: string nullable: true documentId: title: String type: string nullable: true messageTitle: title: String type: string nullable: true documentDescription: title: String type: string nullable: true status: title: DocumentStatus enum: - InProgress - Completed - Declined - Expired - Revoked - Draft - Scheduled type: string senderDetail: $ref: '#/components/schemas/DocumentSender' signerDetail: $ref: '#/components/schemas/DocumentSignerWebhookModel' additionalProperties: false IdentityVerificationSettings: title: IdentityVerificationSettings type: object properties: type: title: Nullable`1 enum: - EveryAccess - UntilSignCompleted - OncePerDocument type: string nullable: true maximumRetryCount: title: Nullable`1 maximum: 10 minimum: 1 type: integer format: int32 nullable: true requireLiveCapture: title: Nullable`1 type: boolean nullable: true requireMatchingSelfie: title: Nullable`1 type: boolean nullable: true nameMatcher: title: Nullable`1 enum: - Strict - Moderate - Lenient type: string nullable: true holdForPrefill: title: Nullable`1 type: boolean nullable: true allowedDocumentTypes: title: List`1 type: array items: title: AllowedDocumentType enum: - Passport - IDCard - DriverLicense type: string nullable: true additionalProperties: false ImageInfo: title: ImageInfo required: - allowedFileExtensions - title type: object properties: title: title: String type: string nullable: true description: title: String type: string nullable: true allowedFileExtensions: title: String type: string nullable: true additionalProperties: false MergeAndSendForSignForm: title: MergeAndSendForSignForm type: object properties: files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true templateIds: title: String[] type: array items: title: String type: string nullable: true useTextTags: title: Boolean type: boolean textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true documentId: title: String type: string nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true roles: title: List`1 type: array items: $ref: '#/components/schemas/Role' nullable: true brandId: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableEmails: title: Boolean type: boolean disableSMS: title: Boolean type: boolean default: false hideDocumentId: title: Nullable`1 type: boolean nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 enablePrintAndSign: title: Boolean type: boolean enableReassign: title: Nullable`1 type: boolean nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true roleRemovalIndices: title: Int32[] type: array items: title: Int32 type: integer format: int32 nullable: true documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true removeFormFields: title: List`1 type: array items: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false ModificationDetails: title: ModificationDetails type: object properties: removedCount: title: Int32 type: integer format: int32 addedCount: title: Int32 type: integer format: int32 additionalProperties: false NotificationSettings: title: NotificationSettings type: object properties: viewed: title: Boolean type: boolean default: true sent: title: Boolean type: boolean default: false deliveryFailed: title: Boolean type: boolean default: true declined: title: Boolean type: boolean default: true revoked: title: Boolean type: boolean default: true reassigned: title: Boolean type: boolean default: true completed: title: Boolean type: boolean default: true signed: title: Boolean type: boolean default: true expired: title: Boolean type: boolean default: true authenticationFailed: title: Boolean type: boolean default: true reminders: title: Boolean type: boolean default: true attachSignedDocument: title: Boolean type: boolean default: false 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 PhoneNumber: title: PhoneNumber type: object properties: countryCode: title: String type: string nullable: true number: title: String type: string nullable: true additionalProperties: false PhoneNumberWebhookModel: title: PhoneNumberWebhookModel type: object properties: countryCode: title: String type: string nullable: true number: title: String type: string nullable: true additionalProperties: false PrefillField: title: PrefillField required: - id - value type: object properties: id: title: String minLength: 1 type: string value: title: String minLength: 1 type: string additionalProperties: false PrefillFieldRequest: title: PrefillFieldRequest required: - fields type: object properties: fields: title: List`1 type: array items: $ref: '#/components/schemas/PrefillField' onBehalfOf: title: String type: string nullable: true additionalProperties: false RecipientChangeLog: title: RecipientChangeLog type: object properties: added: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/Added' nullable: true removed: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/Removed' nullable: true additionalProperties: false RecipientNotificationSettings: title: RecipientNotificationSettings type: object properties: signatureRequest: title: Boolean type: boolean default: true declined: title: Boolean type: boolean default: true revoked: title: Boolean type: boolean default: true signed: title: Boolean type: boolean default: true completed: title: Boolean type: boolean default: true expired: title: Boolean type: boolean default: true reassigned: title: Boolean type: boolean default: true deleted: title: Boolean type: boolean default: true reminders: title: Boolean type: boolean default: true editRecipient: title: Boolean type: boolean default: true editDocument: title: Boolean type: boolean default: true viewed: title: Boolean type: boolean 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 ReminderMessage: title: ReminderMessage type: object properties: message: title: String type: string nullable: true onBehalfOf: title: String type: string nullable: true reminderPhoneNumbers: title: List`1 type: array items: $ref: '#/components/schemas/PhoneNumber' 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 RemoveAuthentication: title: RemoveAuthentication type: object properties: emailId: title: String type: string nullable: true zOrder: title: Nullable`1 type: integer format: int32 nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' onBehalfOf: title: String type: string nullable: true additionalProperties: false Removed: title: Removed type: object properties: signerName: title: String type: string nullable: true signerEmail: title: String type: string nullable: true signerPhoneNumber: title: String type: string nullable: true additionalProperties: false RevokeDocument: title: RevokeDocument required: - message type: object properties: message: title: String minLength: 1 type: string onBehalfOf: title: String type: string nullable: true additionalProperties: false Role: title: Role type: object properties: roleIndex: title: Nullable`1 maximum: 50 minimum: 1 type: integer format: int32 nullable: true signerName: title: String type: string nullable: true signerOrder: title: Int32 type: integer format: int32 signerEmail: title: String type: string nullable: true hostEmail: title: String type: string nullable: true privateMessage: title: String maxLength: 5000 type: string nullable: true authenticationCode: title: String maxLength: 50 type: string nullable: true enableEmailOTP: title: Boolean type: boolean authenticationType: title: AuthenticationType enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string signerType: title: Nullable`1 enum: - Signer - Reviewer - InPersonSigner type: string nullable: true signerRole: title: String type: string nullable: true allowFieldConfiguration: title: Nullable`1 type: boolean nullable: true formFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/FormField' nullable: true existingFormFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/ExistingFormField' nullable: true identityVerificationSettings: $ref: '#/components/schemas/IdentityVerificationSettings' 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string signType: title: Nullable`1 enum: - Single - Group type: string nullable: true groupId: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' authenticationRetryCount: title: Nullable`1 maximum: 10 minimum: 1 type: integer format: int32 nullable: true enableQes: title: Nullable`1 type: boolean nullable: true authenticationSettings: $ref: '#/components/schemas/AuthenticationSettings' additionalProperties: false Roles: title: Roles type: object properties: name: title: String type: string nullable: true index: title: Int32 type: integer format: int32 defaultSignerName: title: String type: string nullable: true defaultSignerEmail: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' signerOrder: title: Int32 type: integer format: int32 signerType: title: SignerType enum: - Signer - Reviewer - InPersonSigner type: string hostEmail: title: String type: string nullable: true hostName: 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string signType: title: SignType enum: - Single - Group type: string defaultGroupId: title: String type: string nullable: true allowRoleEdit: title: Boolean type: boolean allowRoleDelete: title: Boolean type: boolean enableAccessCode: title: Boolean type: boolean enableEmailOTP: title: Boolean type: boolean imposeAuthentication: title: ImposeAuthentication enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string allowFieldConfiguration: title: Boolean type: boolean formFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateFormFields' nullable: true enableEditRecipients: title: Boolean type: boolean enableDeleteRecipients: title: Boolean type: boolean recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableQes: title: Boolean type: boolean groupSigners: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateGroupSigner' nullable: true additionalProperties: false SendForSign: title: SendForSign type: object properties: files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true signers: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentSigner' nullable: true cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true enableSigningOrder: title: Boolean type: boolean default: false expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 reminderSettings: $ref: '#/components/schemas/ReminderSettings' enableEmbeddedSigning: title: Boolean type: boolean default: false deprecated: true disableEmails: title: Boolean type: boolean default: false disableSMS: title: Boolean type: boolean default: false brandId: title: String type: string nullable: true hideDocumentId: title: Nullable`1 type: boolean default: false nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true sendLinkValidTill: title: Nullable`1 type: string format: date-time nullable: true useTextTags: title: Boolean type: boolean default: false textTagDefinitions: title: List`1 type: array items: $ref: '#/components/schemas/TextTagDefinition' nullable: true enablePrintAndSign: title: Boolean type: boolean default: false enableReassign: title: Boolean type: boolean default: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true AutoDetectFields: title: Boolean type: boolean default: false documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false SendForSignFromTemplateForm: title: SendForSignFromTemplateForm type: object properties: files: title: List`1 type: array items: title: IFormFile type: string format: binary nullable: true fileUrls: title: Uri[] type: array items: title: Uri type: string format: uri nullable: true documentId: title: String type: string nullable: true title: title: String maxLength: 256 minLength: 0 type: string nullable: true message: title: String maxLength: 5000 minLength: 0 type: string nullable: true roles: title: List`1 type: array items: $ref: '#/components/schemas/Role' nullable: true brandId: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true disableEmails: title: Boolean type: boolean disableSMS: title: Boolean type: boolean default: false hideDocumentId: title: Nullable`1 type: boolean nullable: true reminderSettings: $ref: '#/components/schemas/ReminderSettings' cc: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentCC' nullable: true expiryDays: title: Int32 type: integer format: int32 deprecated: true expiryDateType: title: Nullable`1 enum: - Days - Hours - SpecificDateTime type: string nullable: true expiryValue: title: Int64 type: integer format: int64 default: 60 enablePrintAndSign: title: Boolean type: boolean enableReassign: title: Nullable`1 type: boolean nullable: true enableSigningOrder: title: Nullable`1 type: boolean nullable: true disableExpiryAlert: title: Nullable`1 type: boolean nullable: true documentInfo: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true onBehalfOf: title: String type: string nullable: true isSandbox: title: Nullable`1 type: boolean nullable: true roleRemovalIndices: title: Int32[] type: array items: title: Int32 type: integer format: int32 nullable: true documentDownloadOption: title: Nullable`1 enum: - Combined - Individually type: string nullable: true metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true nullable: true formGroups: title: List`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true removeFormFields: title: List`1 type: array items: title: String type: string nullable: true recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableAuditTrailLocalization: title: Nullable`1 type: boolean nullable: true downloadFileName: title: String maxLength: 250 minLength: 0 type: string nullable: true scheduledSendTime: title: Nullable`1 type: integer format: int64 nullable: true allowScheduledSend: title: Boolean type: boolean default: false allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false SenderIdentityCreated: title: SenderIdentityCreated type: object properties: senderIdentityId: title: String type: string nullable: true additionalProperties: false SenderIdentityCreator: title: SenderIdentityCreator type: object properties: name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true teamId: title: String type: string nullable: true additionalProperties: false SenderIdentityEvent: title: SenderIdentityEvent type: object properties: object: title: String type: string nullable: true id: title: Guid type: string format: uuid name: title: String type: string nullable: true email: title: String type: string nullable: true status: title: String type: string format: Enumeration nullable: true createdDate: title: Nullable`1 type: string format: date-time nullable: true modifiedDate: title: Nullable`1 type: string format: date-time nullable: true approvedDateTime: title: Nullable`1 type: string format: date-time nullable: true brandId: title: String type: string nullable: true redirectUrl: title: String type: string nullable: true metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true createdBy: $ref: '#/components/schemas/SenderIdentityCreator' locale: title: String type: string nullable: true additionalProperties: false SenderIdentityList: title: SenderIdentityList type: object properties: result: title: List`1 type: array items: $ref: '#/components/schemas/SenderIdentityViewModel' nullable: true pageDetails: $ref: '#/components/schemas/PageDetails' additionalProperties: false SenderIdentityViewModel: title: SenderIdentityViewModel type: object properties: id: title: String type: string nullable: true name: title: String type: string nullable: true email: title: String type: string nullable: true status: title: String type: string nullable: true createdBy: title: String type: string nullable: true approvedDate: title: String type: string nullable: true notificationSettings: $ref: '#/components/schemas/NotificationSettings' brandId: title: String type: string nullable: true redirectUrl: title: String type: string nullable: true metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true locale: title: String type: string nullable: true additionalProperties: false SignatureFrameSettings: title: SignatureFrameSettings type: object properties: enableSignatureFrame: title: Boolean type: boolean default: false showRecipientName: title: Boolean type: boolean default: false showRecipientEmail: title: Boolean type: boolean default: false showTimeStamp: title: Boolean type: boolean default: false additionalProperties: false SignerAuthenticationSettings: title: SignerAuthenticationSettings type: object properties: authenticationFrequency: title: String type: string nullable: true status: title: String type: string nullable: true additionalProperties: false SignerAuthenticationWebhookModel: title: SignerAuthenticationWebhookModel type: object properties: authenticationFrequency: title: String type: string nullable: true status: title: String type: string nullable: true additionalProperties: false Size: title: Size type: object properties: width: title: Single minimum: 0 type: number format: float default: 0 height: title: Single minimum: 0 type: number format: float default: 0 additionalProperties: false TeamCreated: title: TeamCreated type: object properties: teamId: title: String type: string nullable: true additionalProperties: false TeamDocumentRecords: title: TeamDocumentRecords type: object properties: pageDetails: $ref: '#/components/schemas/PageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/Document' nullable: true additionalProperties: false TeamListResponse: title: TeamListResponse type: object properties: pageDetails: $ref: '#/components/schemas/TeamPageDetails' results: title: List`1 type: array items: $ref: '#/components/schemas/Teams' nullable: true additionalProperties: false TeamPageDetails: title: TeamPageDetails type: object properties: pageSize: title: Int32 type: integer format: int32 page: title: Int32 type: integer format: int32 additionalProperties: false TeamResponse: title: TeamResponse type: object properties: teamId: title: String type: string nullable: true teamName: title: String type: string nullable: true users: title: List`1 type: array items: $ref: '#/components/schemas/TeamUsers' nullable: true createdDate: title: Int64 type: integer format: int64 modifiedDate: title: Int64 type: integer format: int64 additionalProperties: false TeamUpdateRequest: title: TeamUpdateRequest required: - teamId - teamName type: object properties: teamId: title: String minLength: 1 type: string teamName: title: String maxLength: 255 minLength: 0 type: string additionalProperties: false TeamUsers: title: TeamUsers type: object properties: userId: title: String type: string nullable: true email: title: String type: string nullable: true firstName: title: String type: string nullable: true lastName: title: String type: string nullable: true userRole: title: UserRole enum: - AccountAdmin - TeamAdmin - TeamMember type: string userStatus: title: UserStatus enum: - Active - InvitationPending - Deactivated type: string additionalProperties: false Teams: title: Teams type: object properties: teamName: title: String type: string nullable: true teamId: title: String type: string nullable: true createdDate: title: Int64 type: integer format: int64 modifiedDate: title: Int64 type: integer format: int64 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 TemplateCC: title: TemplateCC type: object properties: emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true additionalProperties: false TemplateCcWebhookModel: title: TemplateCcWebhookModel type: object properties: emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true id: title: String type: string nullable: true additionalProperties: false TemplateCreated: title: TemplateCreated type: object properties: templateId: title: String type: string nullable: true additionalProperties: false TemplateEvent: title: TemplateEvent type: object properties: object: title: String type: string nullable: true templateId: title: String type: string nullable: true allowNewFiles: title: Nullable`1 type: boolean nullable: true allowModifyFiles: title: Nullable`1 type: boolean nullable: true senderDetail: $ref: '#/components/schemas/TemplateSender' ccDetails: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateCcWebhookModel' nullable: true createdDate: title: Nullable`1 type: string format: date-time nullable: true activityDate: title: Nullable`1 type: string format: date-time nullable: true 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: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateSigner' nullable: true enableSigningOrder: title: Boolean type: boolean templateName: title: String type: string nullable: true templateDescription: title: String type: string nullable: true errorMessage: title: String type: string nullable: true isTemplate: title: Boolean type: boolean default: false BrandId: title: String type: string nullable: true onBehalfOf: title: String type: string nullable: true labels: title: IEnumerable`1 type: array items: title: String type: string nullable: true templateLabels: title: IEnumerable`1 type: array items: title: String type: string nullable: true formFieldPermission: $ref: '#/components/schemas/FormFieldPermissionWebhookModel' groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettingsWebhookModel' behalfOf: $ref: '#/components/schemas/BehalfOfWebhookModel' enableAllowSignEverywhere: title: Nullable`1 type: boolean nullable: true documentTimeZone: title: String type: string nullable: true additionalProperties: false TemplateFiles: title: TemplateFiles type: object properties: documentId: title: String type: string nullable: true documentName: title: String type: string nullable: true order: title: Int32 type: integer format: int32 pageCount: title: Int32 type: integer format: int32 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 TemplateGroupSigner: title: TemplateGroupSigner type: object properties: signerEmail: title: String type: string nullable: true signerName: title: String type: string nullable: true additionalProperties: false TemplateGroupSignerWebhookModel: title: TemplateGroupSignerWebhookModel type: object properties: signerEmail: title: String type: string nullable: true signerName: title: String type: string nullable: true additionalProperties: false TemplateProperties: title: TemplateProperties type: object properties: templateId: title: String type: string nullable: true title: title: String type: string nullable: true description: title: String type: string nullable: true documentTitle: title: String type: string nullable: true documentMessage: title: String type: string nullable: true files: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateFiles' nullable: true roles: title: Roles[] type: array items: $ref: '#/components/schemas/Roles' nullable: true formGroups: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/FormGroup' nullable: true commonFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/TemplateFormFields' nullable: true cCDetails: title: IEnumerable`1 type: array items: title: String type: string nullable: true brandId: title: String type: string nullable: true allowMessageEditing: title: Boolean type: boolean allowNewRoles: title: Boolean type: boolean allowNewFiles: title: Boolean type: boolean allowModifyFiles: title: Boolean type: boolean enableReassign: title: Boolean type: boolean EnablePrintAndSign: title: Boolean type: boolean enableSigningOrder: title: Boolean type: boolean createdDate: title: Int64 type: integer format: int64 createdBy: $ref: '#/components/schemas/TemplateSenderDetail' sharedTemplateDetail: title: List`1 type: array items: $ref: '#/components/schemas/TemplateSharedTemplateDetail' nullable: true deprecated: true documentInfo: title: DocumentInfo[] type: array items: $ref: '#/components/schemas/DocumentInfo' nullable: true labels: title: List`1 type: array items: title: String type: string nullable: true templateLabels: title: List`1 type: array items: title: String type: string nullable: true behalfOf: $ref: '#/components/schemas/BehalfOf' documentDownloadOption: title: DocumentDownloadOption enum: - Combined - Individually type: string recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' formFieldPermission: $ref: '#/components/schemas/FormFieldPermission' allowedSignatureTypes: title: List`1 type: array items: title: SignatureType enum: - Text - Draw - Image type: string nullable: true groupSignerSettings: $ref: '#/components/schemas/GroupSignerSettings' sharing: $ref: '#/components/schemas/TemplateSharing' enableAllowSignEverywhere: title: Boolean type: boolean documentTimeZone: title: String type: string nullable: true additionalProperties: false TemplateRecords: title: TemplateRecords type: object properties: pageDetails: $ref: '#/components/schemas/PageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/Template' nullable: true 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:

format: int32 locale: title: Locales enum: - EN - 'NO' - FR - DE - ES - BG - CS - DA - IT - NL - PL - PT - RO - RU - SV - Default - JA - TH - ZH_CN - ZH_TW - KO type: string signType: title: SignType enum: - Single - Group type: string defaultGroupId: title: String type: string nullable: true imposeAuthentication: title: ImposeAuthentication enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string phoneNumber: $ref: '#/components/schemas/PhoneNumber' deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string allowFieldConfiguration: title: Boolean type: boolean formFields: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/FormField' nullable: true allowRoleEdit: title: Boolean type: boolean allowRoleDelete: title: Boolean type: boolean recipientNotificationSettings: $ref: '#/components/schemas/RecipientNotificationSettings' enableQes: title: Nullable`1 type: boolean nullable: true additionalProperties: false TemplateSender: title: TemplateSender type: object properties: name: title: String type: string nullable: true teamId: title: String type: string nullable: true emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true id: title: String type: string nullable: true additionalProperties: false TemplateSenderDetail: title: TemplateSenderDetail type: object properties: emailAddress: title: String type: string nullable: true name: title: String type: string nullable: true additionalProperties: false TemplateSenderDetails: title: TemplateSenderDetails type: object properties: name: title: String type: string nullable: true emailAddress: title: String type: string nullable: true userId: title: String type: string nullable: true additionalProperties: false TemplateShareErrorResponse: title: TemplateShareErrorResponse type: object properties: teams: title: List`1 type: array items: title: String type: string nullable: true templateId: title: String type: string nullable: true errorType: title: String type: string nullable: true error: title: String type: string nullable: true additionalProperties: false TemplateShareRequest: title: TemplateShareRequest type: object properties: teams: title: List`1 type: array items: $ref: '#/components/schemas/TemplateTeamShareRequest' nullable: true additionalProperties: false TemplateSharedTemplateDetail: title: TemplateSharedTemplateDetail type: object properties: teamId: title: String type: string nullable: true accessType: title: TemplateAccessType enum: - Use - Edit type: string additionalProperties: false TemplateSharing: title: TemplateSharing type: object properties: teams: title: List`1 type: array items: $ref: '#/components/schemas/TemplateTeamShare' nullable: true additionalProperties: false TemplateSigner: title: TemplateSigner type: object properties: signerName: title: String type: string nullable: true signerRole: title: String type: string nullable: true signerEmail: title: String type: string nullable: true groupSigners: title: List`1 type: array items: $ref: '#/components/schemas/TemplateGroupSignerWebhookModel' nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumberWebhookModel' enableAccessCode: title: Boolean type: boolean enableEmailOTP: title: Boolean type: boolean status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string userId: title: String type: string nullable: true order: title: Int32 type: integer format: int32 signerType: title: String type: string nullable: true signType: title: String type: string nullable: true groupId: title: String type: string nullable: true hostEmail: title: String type: string nullable: true hostName: title: String type: string nullable: true hostUserId: title: String type: string nullable: true imposeAuthentication: title: String type: string nullable: true allowFieldConfiguration: title: Boolean type: boolean roleIndex: title: Int32 type: integer format: int32 additionalProperties: false TemplateSignerDetails: title: TemplateSignerDetails type: object properties: signerName: title: String type: string nullable: true signerRole: title: String type: string nullable: true signerEmail: title: String type: string nullable: true phoneNumber: $ref: '#/components/schemas/PhoneNumber' status: title: SignerStatus enum: - None - NotCompleted - Completed - Declined - Revoked - Expired type: string enableAccessCode: title: Boolean type: boolean enableEmailOTP: title: Boolean type: boolean imposeAuthentication: title: ImposeAuthentication enum: - None - EmailOTP - AccessCode - SMSOTP - IdVerification type: string deliveryMode: title: DeliveryMode enum: - Email - SMS - EmailAndSMS - WhatsApp type: string allowFieldConfiguration: title: Boolean type: boolean default: false userId: title: String type: string nullable: true order: title: Int32 type: integer format: int32 signerType: title: SignerType enum: - Signer - Reviewer - InPersonSigner type: string default: Signer hostEmail: title: String type: string nullable: true hostName: title: String type: string nullable: true hostUserId: title: String type: string nullable: true signType: title: SignType enum: - Single - Group type: string groupId: title: String type: string nullable: true groupSigners: title: TemplateGroupSigner[] type: array items: $ref: '#/components/schemas/TemplateGroupSigner' nullable: true additionalProperties: false TemplateTag: title: TemplateTag required: - templateId type: object properties: templateId: title: String minLength: 1 type: string documentLabels: title: List`1 type: array items: title: String type: string nullable: true templateLabels: title: List`1 type: array items: title: String type: string nullable: true onBehalfOf: title: String type: string nullable: true additionalProperties: false TemplateTeamShare: title: TemplateTeamShare type: object properties: teamId: title: String type: string nullable: true accessType: title: TemplateAccessType enum: - Use - Edit - None type: string additionalProperties: false TemplateTeamShareRequest: title: TemplateTeamShareRequest required: - action - teamId type: object properties: teamId: title: String minLength: 1 type: string action: title: Nullable`1 enum: - Grant - Revoke type: string accessLevel: title: Nullable`1 enum: - Use - Edit type: string nullable: true additionalProperties: false TextTagDefinition: title: TextTagDefinition required: - definitionId - signerIndex - type type: object properties: definitionId: title: String minLength: 1 type: string type: title: Nullable`1 enum: - Signature - Initial - CheckBox - TextBox - Label - DateSigned - RadioButton - Image - Attachment - EditableDate - Hyperlink - Dropdown - Title - Company - Formula - Drawing type: string signerIndex: title: Int32 maximum: 50 minimum: 1 type: integer format: int32 isRequired: title: Boolean type: boolean placeholder: title: String type: string nullable: true fieldId: title: String type: string nullable: true font: $ref: '#/components/schemas/Font' validation: $ref: '#/components/schemas/Validation' size: $ref: '#/components/schemas/Size' dateFormat: title: String type: string nullable: true timeFormat: title: String type: string nullable: true radioGroupName: title: String type: string nullable: true groupName: title: String type: string nullable: true value: title: String type: string nullable: true dropdownOptions: title: String[] type: array items: title: String type: string nullable: true imageInfo: $ref: '#/components/schemas/ImageInfo' hyperlinkText: title: String type: string nullable: true attachmentInfo: $ref: '#/components/schemas/AttachmentInfo' backgroundHexColor: title: String type: string nullable: true isReadOnly: title: Boolean type: boolean offset: $ref: '#/components/schemas/TextTagOffset' label: title: String type: string nullable: true tabIndex: title: Nullable`1 maximum: 2147483647 minimum: -1 type: integer format: int32 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 maximum: 2147483647 minimum: 0 type: integer format: int32 formulaFieldSettings: $ref: '#/components/schemas/FormulaFieldSettings' resizeOption: title: Nullable`1 enum: - GrowVertically - GrowHorizontally - GrowBoth - Fixed - AutoResizeFont type: string nullable: true collaborationSettings: $ref: '#/components/schemas/CollaborationSettings' isMasked: title: Nullable`1 type: boolean default: false nullable: true conditionalRules: title: IEnumerable`1 type: array items: $ref: '#/components/schemas/ConditionalRule' nullable: true additionalProperties: false TextTagOffset: title: TextTagOffset type: object properties: offsetX: title: Double type: number format: double offsetY: title: Double type: number format: double additionalProperties: false UpdateGroupContact: title: UpdateGroupContact type: object properties: groupName: title: String type: string nullable: true directories: title: List`1 type: array items: title: String type: string nullable: true contacts: title: List`1 type: array items: $ref: '#/components/schemas/GroupUser' nullable: true additionalProperties: false UpdateUser: title: UpdateUser required: - userId type: object properties: userId: title: String minLength: 1 type: string userRole: title: UserRoleType enum: - Admin - TeamAdmin - Member type: string userStatus: title: UserStatusOption enum: - Activate - Deactivate type: string toUserId: title: String type: string nullable: true additionalProperties: false UpdateUserMetaData: title: UpdateUserMetaData required: - metaData - userId type: object properties: userId: title: String minLength: 1 type: string metaData: title: Dictionary`2 maxLength: 50 type: object additionalProperties: title: String type: string nullable: true additionalProperties: false UserPageDetails: title: UserPageDetails type: object properties: pageSize: title: Int32 type: integer format: int32 page: title: Int32 type: integer format: int32 additionalProperties: false UserProperties: title: UserProperties type: object properties: userId: title: String type: string nullable: true email: title: String type: string nullable: true firstName: title: String type: string nullable: true lastName: title: String type: string nullable: true teamId: title: String type: string nullable: true teamName: title: String type: string nullable: true role: title: String type: string nullable: true userStatus: title: String type: string nullable: true createdDate: title: Int64 type: integer format: int64 modifiedDate: title: Int64 type: integer format: int64 metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true additionalProperties: false UserRecords: title: UserRecords type: object properties: pageDetails: $ref: '#/components/schemas/UserPageDetails' result: title: List`1 type: array items: $ref: '#/components/schemas/UsersDetails' nullable: true additionalProperties: false UsersDetails: title: UsersDetails type: object properties: userId: title: Guid type: string format: uuid email: title: String type: string nullable: true firstName: title: String type: string nullable: true lastName: title: String type: string nullable: true teamId: title: Guid type: string format: uuid teamName: title: String type: string nullable: true role: title: String type: string nullable: true userStatus: title: String type: string nullable: true createdDate: title: Int64 type: integer format: int64 modifiedDate: title: Int64 type: integer format: int64 metaData: title: Dictionary`2 type: object additionalProperties: title: String type: string nullable: true nullable: true additionalProperties: false Validation: title: Validation required: - type type: object properties: type: title: Nullable`1 enum: - NumberOnly - Email - Currency - Regex - None type: string regex: title: String type: string nullable: true regexMessage: title: String type: string nullable: true additionalProperties: false VerificationDataRequest: title: VerificationDataRequest type: object properties: emailId: title: String type: string nullable: true countryCode: title: String type: string nullable: true phoneNumber: title: String type: string nullable: true order: title: Int32 type: integer format: int32 onBehalfOf: title: String type: string nullable: true additionalProperties: false ViewBrandDetails: title: ViewBrandDetails type: object properties: brandId: title: String type: string nullable: true brandLogo: title: String type: string nullable: true brandName: title: String type: string nullable: true backgroundColor: title: String type: string nullable: true buttonColor: title: String type: string nullable: true buttonTextColor: title: String type: string nullable: true emailDisplayName: title: String type: string nullable: true disclaimerTitle: title: String type: string nullable: true disclaimerDescription: title: String type: string nullable: true redirectUrl: title: String type: string nullable: true isDefault: title: Boolean type: boolean canHideTagLine: title: Boolean type: boolean combineAuditTrail: title: Boolean type: boolean combineAttachments: title: Boolean type: boolean excludeAuditTrailFromEmail: title: Boolean type: boolean emailSignedDocument: title: EmailSignedDocument enum: - Attachment - DocumentLink type: string documentTimeZone: title: String type: string nullable: true showBuiltInFormFields: title: Boolean type: boolean allowCustomFieldCreation: title: Boolean type: boolean showSharedCustomFields: title: Boolean type: boolean hideDecline: title: Boolean type: boolean hideSave: title: Boolean type: boolean documentExpirySettings: $ref: '#/components/schemas/DocumentExpirySettings' customDomainSettings: $ref: '#/components/schemas/CustomDomainSettings' isDomainVerified: title: Boolean type: boolean signatureFrameSettings: $ref: '#/components/schemas/SignatureFrameSettings' additionalProperties: false ViewCustomFieldDetails: title: ViewCustomFieldDetails type: object properties: customFieldId: title: String type: string nullable: true fieldName: title: String type: string nullable: true fieldDescription: title: String type: string nullable: true fieldOrder: title: Int32 type: integer format: int32 brandId: title: String type: string nullable: true sharedField: title: Boolean type: boolean formField: $ref: '#/components/schemas/CustomFormField' additionalProperties: false WebhookActorDetails: title: WebhookActorDetails required: - id - userType type: object properties: userType: title: ContextUserType enum: - Sender - Signer - Admin - Creator - SenderIdentity - Cc type: string id: title: String minLength: 1 type: string additionalProperties: false WebhookContext: title: WebhookContext type: object properties: eventType: title: WebHookEventType enum: - Sent - Signed - Completed - Declined - Revoked - Reassigned - Expired - Viewed - AuthenticationFailed - DeliveryFailed - Verification - SendFailed - DraftCreated - SenderIdentityCreated - SenderIdentityUpdated - SenderIdentityDeleted - SenderIdentityRevoked - SenderIdentityVerified - SenderIdentityDenied - TemplateCreated - TemplateCreateFailed - TemplateDraftCreated - TemplateSendFailed - IdentityVerificationInitiated - IdentityVerificationSucceeded - IdentityVerificationFailed - Reminder - Edited - EditFailed - TemplateEdited - SignerSaved type: string actor: $ref: '#/components/schemas/WebhookActorDetails' previousState: title: Object nullable: true additionalProperties: false WebhookEvent: title: WebhookEvent type: object properties: event: $ref: '#/components/schemas/WebhookEventMetadata' context: $ref: '#/components/schemas/WebhookContext' data: title: IWebhookData oneOf: - $ref: '#/components/schemas/DocumentEvent' - $ref: '#/components/schemas/SenderIdentityEvent' - $ref: '#/components/schemas/TemplateEvent' - $ref: '#/components/schemas/IdentityVerificationEvent' nullable: true document: $ref: '#/components/schemas/DocumentEvent' additionalProperties: false WebhookEventMetadata: title: WebhookEventMetadata type: object properties: id: title: Guid type: string format: uuid created: title: DateTime type: string format: date-time eventType: title: WebHookEventType enum: - Sent - Signed - Completed - Declined - Revoked - Reassigned - Expired - Viewed - AuthenticationFailed - DeliveryFailed - Verification - SendFailed - DraftCreated - SenderIdentityCreated - SenderIdentityUpdated - SenderIdentityDeleted - SenderIdentityRevoked - SenderIdentityVerified - SenderIdentityDenied - TemplateCreated - TemplateCreateFailed - TemplateDraftCreated - TemplateSendFailed - IdentityVerificationInitiated - IdentityVerificationSucceeded - IdentityVerificationFailed - Reminder - Edited - EditFailed - TemplateEdited - SignerSaved type: string clientId: title: String type: string nullable: true environment: title: ApplicationEnvironment enum: - Test - Live type: string additionalProperties: false securitySchemes: Bearer: type: apiKey description: 'Format ''Bearer'' [space] [TOKEN]. Ex: ''Bearer eyJhbGciOiJIUzI1N''' name: Authorization in: header X-API-KEY: type: apiKey description: 'Format [API-KEY]. Ex: ''abcdef12345''' name: X-API-KEY in: header security: - Bearer: [] - X-API-KEY: [] tags: - name: Branding - name: Contacts - name: Custom Field - name: Document - name: GroupContacts - name: Identity Verification - name: Plan - name: Sender Identities - name: Teams - name: Template - name: User externalDocs: description: BoldSign Developer Documentation url: https://developers.boldsign.com/