Namirial · Schema
EnvelopeBulkSendRequest
The request model for sending an envelope bulk.
CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance
Properties
| Name | Type | Description |
|---|---|---|
| Documents | array | The documents for the envelope. |
| Name | string | The name of the envelope. |
| MetaData | string | The metadata of the envelope. |
| AddDocumentTimestamp | boolean | If true, a timestamp is added to all documents of the envelope at the end of each signing activity. |
| ShareWithTeam | boolean | If true, this envelope is shared with your teams. |
| LockFormFieldsOnFinish | boolean | If true, form fields are locked after the envelope is finished. |
| LateIdentification | boolean | If true, oAuth identification is performed when signing not when opening the document. |
| UnassignedElements | object | The elements which are not assigned to any action. |
| Activities | array | The steps for the envelope. |
| EmailConfiguration | object | The configuration for notifications. |
| ReminderConfiguration | object | The configuration for reminders. |
| ExpirationConfiguration | object | The configuration of the expiration for the envelope. |
| CallbackConfiguration | object | The configuration of the callbacks for a custom integration. |
| AgreementConfiguration | object | The configuration of the agreement. Requires that the organization allows custom agreement settings. |
| SealingConfiguration | object | The custom sealing configuration for the envelope. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/namirial/json-schema/namirial-envelope-bulk-send-request-schema.json",
"title": "EnvelopeBulkSendRequest",
"description": "The request model for sending an envelope bulk.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/namirial-envelopebulk-api-openapi.yml#/components/schemas/EnvelopeBulkSendRequest",
"required": [
"Documents",
"Name",
"Activities"
],
"type": "object",
"properties": {
"Documents": {
"description": "The documents for the envelope.",
"maxItems": 100,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendDocument"
}
},
"Name": {
"description": "The name of the envelope.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"MetaData": {
"description": "The metadata of the envelope.",
"maxLength": 204800,
"minLength": 0,
"type": "string"
},
"AddDocumentTimestamp": {
"description": "If true, a timestamp is added to all documents of the envelope at the end of each signing activity.",
"type": "boolean"
},
"ShareWithTeam": {
"description": "If true, this envelope is shared with your teams.",
"type": "boolean"
},
"LockFormFieldsOnFinish": {
"description": "If true, form fields are locked after the envelope is finished.",
"type": "boolean"
},
"LateIdentification": {
"description": "If true, oAuth identification is performed when signing not when opening the document.",
"type": "boolean"
},
"UnassignedElements": {
"$ref": "#/$defs/EnvelopeBulkSendUnassignedElements",
"description": "The elements which are not assigned to any action."
},
"Activities": {
"description": "The steps for the envelope.",
"maxItems": 50,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendActivity"
}
},
"EmailConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendEmailConfiguration",
"description": "The configuration for notifications."
},
"ReminderConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendReminderConfiguration",
"description": "The configuration for reminders."
},
"ExpirationConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendExpirationConfiguration",
"description": "The configuration of the expiration for the envelope."
},
"CallbackConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendCallbackConfiguration",
"description": "The configuration of the callbacks for a custom integration."
},
"AgreementConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendAgreementConfiguration",
"description": "The configuration of the agreement.\nRequires that the organization allows custom agreement settings."
},
"SealingConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendSealingConfiguration",
"description": "The custom sealing configuration for the envelope."
}
},
"$defs": {
"EnvelopeBulkSendATrustCertificateSignatureData": {
"description": "The recipient configuration for signing with an A-Trust certificate.",
"type": "object",
"properties": {
"PhoneNumber": {
"description": "The phone number of the recipient.",
"maxLength": 250,
"minLength": 0,
"pattern": "^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$",
"type": "string"
}
}
},
"EnvelopeBulkSendATrustCertificateSignatureType": {
"description": "The configuration of the A-Trust certificate signature.",
"type": "object",
"properties": {
"TemplateId": {
"description": "The identifier of the A-Trust template.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"Preferred": {
"description": "If true, the signature type is set as preferred.\nOnly one signature type may be marked.",
"type": "boolean"
}
}
},
"EnvelopeBulkSendAccessCodeAuthentication": {
"description": "The configuration for authentication with a predefined access code.",
"type": "object",
"properties": {
"Code": {
"description": "The code for authenticating the recipient.",
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
},
"EnvelopeBulkSendAction": {
"description": "The action of the activity with the possibility to define a bulk. Exactly one definition must be used!",
"type": "object",
"properties": {
"SendCopy": {
"$ref": "#/$defs/EnvelopeBulkSendSendCopy",
"description": "The definition of the copy action."
},
"SignAutomatic": {
"$ref": "#/$defs/EnvelopeBulkSendSignAutomatic",
"description": "The definition of the automatic sign action."
},
"Sign": {
"$ref": "#/$defs/EnvelopeBulkSendSign",
"description": "The definition of the sign action."
},
"View": {
"$ref": "#/$defs/EnvelopeBulkSendView",
"description": "The definition of the view action."
},
"SignAsP7M": {
"$ref": "#/$defs/EnvelopeBulkSendSignAsP7M",
"description": "The definition of the P7M sign action."
},
"SignBulk": {
"$ref": "#/$defs/EnvelopeBulkSendSignBulk",
"description": "The definition of the bulk."
}
}
},
"EnvelopeBulkSendActionCallbackSelection": {
"description": "The selection of events which trigger the callback.",
"type": "object",
"properties": {
"ConfirmTransactionCode": {
"description": "If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.",
"type": "boolean"
},
"AgreementAccepted": {
"description": "If true, the callback is triggered when the user accepted the agreement.",
"type": "boolean"
},
"AgreementRejected": {
"description": "If true, the callback is triggered when the user rejected the agreement.",
"type": "boolean"
},
"PrepareAuthenticationSuccess": {
"description": "If true, the callback is triggered when the preparation of the authentication process succeeded.",
"type": "boolean"
},
"AuthenticationFailed": {
"description": "If true, the callback is triggered when the user failed to authenticate.",
"type": "boolean"
},
"AuthenticationSuccess": {
"description": "If true, the callback is triggered when the user succeeded to authenticate.",
"type": "boolean"
},
"AuditTrailRequested": {
"description": "If true, the callback is triggered when the audit trail was requested.",
"type": "boolean"
},
"AuditTrailXmlRequested": {
"description": "If true, the callback is triggered when the audit trail XML was requested.",
"type": "boolean"
},
"CalledPage": {
"description": "If true, the callback is triggered when the SignAnyWhere Viewer was requested.",
"type": "boolean"
},
"DocumentDownloaded": {
"description": "If true, the callback is triggered when the document download was requested.",
"type": "boolean"
},
"FlattenedDocumentDownloaded": {
"description": "If true, the callback is triggered when the flattened document download was requested.",
"type": "boolean"
},
"AddedAnnotation": {
"description": "If true, the callback is triggered when an annotation was added.",
"type": "boolean"
},
"AddedAttachment": {
"description": "If true, the callback is triggered when an attachment was added.",
"type": "boolean"
},
"AppendedDocument": {
"description": "If true, the callback is triggered when a document was appended.",
"type": "boolean"
},
"FormsFilled": {
"description": "If true, the callback is triggered when a form field was filled.",
"type": "boolean"
},
"ConfirmReading": {
"description": "If true, the callback is triggered when a reading task was completed.",
"type": "boolean"
},
"SendTransactionCode": {
"description": "If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.",
"type": "boolean"
},
"PrepareSignWorkstepDocument": {
"description": "If true, the callback is triggered when a signature was prepared for signing.",
"type": "boolean"
},
"SignWorkstepDocument": {
"description": "If true, the callback is triggered when a signature was applied.",
"type": "boolean"
},
"UndoAction": {
"description": "If true, the callback is triggered when an action was undone.",
"type": "boolean"
},
"WorkstepCreated": {
"description": "If true, the callback is triggered when a workstep was created.",
"type": "boolean"
},
"WorkstepFinished": {
"description": "If true, the callback is triggered when a workstep was finished.",
"type": "boolean"
},
"WorkstepRejected": {
"description": "If true, the callback is triggered when a workstep was rejected.",
"type": "boolean"
},
"DisablePolicyAndValidityChecks": {
"description": "If true, the callback is triggered when policy and validity checks were disabled.",
"type": "boolean"
},
"EnablePolicyAndValidityChecks": {
"description": "If true, the callback is triggered when policy and validity checks were enabled.",
"type": "boolean"
},
"AppendFileToWorkstep": {
"description": "If true, the callback is triggered when a file was appended to the workstep.",
"type": "boolean"
},
"AppendTasksToWorkstep": {
"description": "If true, the callback is triggered when a task was added to the workstep.",
"type": "boolean"
},
"SetOptionalDocumentState": {
"description": "If true, the callback is triggered when an optional document became either active or inactive.",
"type": "boolean"
},
"PreparePayloadForBatch": {
"description": "If true, the callback is triggered when the payload was prepared for batch signing.",
"type": "boolean"
}
}
},
"EnvelopeBulkSendActivity": {
"description": "Define an activity with the possibility of bulk.",
"type": "object",
"properties": {
"Action": {
"$ref": "#/$defs/EnvelopeBulkSendAction",
"description": "The action assigned to the activity."
},
"VisibilityOptions": {
"description": "The document visibility options for the activity.",
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendVisibilityOption"
}
}
}
},
"EnvelopeBulkSendActivityActionCallbackConfiguration": {
"description": "The configuration of the callback for workstep events.",
"required": [
"Url"
],
"type": "object",
"properties": {
"Url": {
"description": "The callback URL triggered for the selected events.",
"maxLength": 8000,
"minLength": 0,
"type": "string"
},
"ActionCallbackSelection": {
"$ref": "#/$defs/EnvelopeBulkSendActionCallbackSelection",
"description": "The selection of events which trigger the callback."
}
}
},
"EnvelopeBulkSendAdvancedRecipientConfiguration": {
"description": "The advanced configuration for the recipient.",
"type": "object",
"properties": {
"ContactInformation": {
"$ref": "#/$defs/EnvelopeBulkSendContactInformation",
"description": "The contact information of the recipient."
},
"PersonalMessage": {
"description": "The personal message for the recipient.",
"maxLength": 204800,
"minLength": 0,
"type": "string"
},
"AuthenticationConfiguration": {
"$ref": "#/$defs/EnvelopeBulkSendAuthenticationConfiguration",
"description": "The configuration for the authentication of the recipient."
},
"SendEmails": {
"description": "Obsolete: If true, emails will be sent out for this recipient.\nUse NotificationChannel property instead, which also allows sending with other notification channels than Email.\nNotificationChannel.None is the equivalent of sending false.\nNotificationChannel.Email is the equivalent of sending true.\nIf the NotificationChannel property is used/sent this property will be ignored.",
"type": "boolean"
},
"NotificationChannel": {
"description": "Which channel is used for sending notifications to the recipient.\nDefault Email if not specified.",
"enum": [
"None",
"Email",
"Sms",
"WhatsApp"
],
"type": "string"
},
"AllowAccessAfterFinish": {
"description": "If true, the recipient is allowed to access the action after it has been finished.\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\nThe default value is taken from the OrganizationSettings.",
"type": "boolean"
},
"IncludedEmailAppLinks": {
"$ref": "#/$defs/EnvelopeBulkSendEmailAppLinks",
"description": "The configuration for mobile app links in email messages."
},
"AllowDelegation": {
"description": "If true, the recipient may delegate this activity to another person.",
"type": "boolean"
},
"RequireViewContentBeforeFormFilling": {
"description": "If true, the signer has to confirm the reading of all documents as first task.",
"type": "boolean"
}
}
},
"EnvelopeBulkSendAgreementConfiguration": {
"description": "The configuration of the agreement.",
"type": "object",
"properties": {
"Translations": {
"description": "The agreement and its translations to be used.\nIf no custom agreement is specified, the default organization agreement will be used.",
"maxItems": 228,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendAgreementTranslation"
}
}
}
},
"EnvelopeBulkSendAgreementTranslation": {
"description": "A translation for the agreement.",
"required": [
"LanguageCode",
"Text"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "The language of the translated agreement.",
"enum": [
"AF",
"AF_ZA",
"AR",
"AR_AE",
"AR_BH",
"AR_DZ",
"AR_EG",
"AR_IQ",
"AR_JO",
"AR_KW",
"AR_LB",
"AR_LY",
"AR_MA",
"AR_OM",
"AR_QA",
"AR_SA",
"AR_SY",
"AR_TN",
"AR_YE",
"AZ",
"BE",
"BE_BY",
"BG",
"BG_BG",
"CA",
"CA_ES",
"CS",
"CS_CZ",
"CY",
"CY_GB",
"DA",
"DA_DK",
"DE",
"DE_AT",
"DE_CH",
"DE_DE",
"DE_LI",
"DE_LU",
"DV",
"DV_MV",
"EL",
"EL_GR",
"EN",
"EN_AU",
"EN_BZ",
"EN_CA",
"EN_GB",
"EN_IE",
"EN_JM",
"EN_NZ",
"EN_PH",
"EN_TT",
"EN_US",
"EN_ZA",
"EN_ZW",
"ES",
"ES_AR",
"ES_BO",
"ES_CL",
"ES_CO",
"ES_CR",
"ES_DO",
"ES_EC",
"ES_ES",
"ES_GT",
"ES_HN",
"ES_MX",
"ES_NI",
"ES_PA",
"ES_PE",
"ES_PR",
"ES_PY",
"ES_SV",
"ES_UY",
"ES_VE",
"ET",
"ET_EE",
"EU",
"EU_ES",
"FA",
"FA_IR",
"FI",
"FI_FI",
"FO",
"FO_FO",
"FR",
"FR_BE",
"FR_CA",
"FR_CH",
"FR_FR",
"FR_LU",
"FR_MC",
"GL",
"GL_ES",
"GU",
"GU_IN",
"HE",
"HE_IL",
"HI",
"HI_IN",
"HR",
"HR_BA",
"HR_HR",
"HU",
"HU_HU",
"HY",
"HY_AM",
"ID",
"ID_ID",
"IS",
"IS_IS",
"IT",
"IT_CH",
"IT_IT",
"JA",
"JA_JP",
"KA",
"KA_GE",
"KK",
"KK_KZ",
"KN",
"KN_IN",
"KO",
"KO_KR",
"KOK",
"KOK_IN",
"KY",
"KY_KG",
"LT",
"LT_LT",
"LV",
"LV_LV",
"MI",
"MI_NZ",
"MK",
"MK_MK",
"MN",
"MN_MN",
"MR",
"MR_IN",
"MS",
"MS_BN",
"MS_MY",
"MT",
"MT_MT",
"NB",
"NB_NO",
"NL",
"NL_BE",
"NL_NL",
"NN_NO",
"PA",
"PA_IN",
"PL",
"PL_PL",
"PS",
"PT",
"PT_BR",
"PT_PT",
"RO",
"RO_RO",
"RU",
"RU_RU",
"SA",
"SA_IN",
"SE",
"SE_FI",
"SE_NO",
"SE_SE",
"SK",
"SK_SK",
"SL",
"SL_SI",
"SQ",
"SQ_AL",
"SV",
"SV_FI",
"SV_SE",
"SW",
"SW_KE",
"SYR",
"SYR_SY",
"TA",
"TA_IN",
"TE",
"TE_IN",
"TH",
"TH_TH",
"TN",
"TN_ZA",
"TR",
"TR_TR",
"TT",
"TT_RU",
"TS",
"UK",
"UK_UA",
"UR",
"UR_PK",
"UZ",
"VI",
"VI_VN",
"XH",
"XH_ZA",
"ZH",
"ZH_CN",
"ZH_HK",
"ZH_MO",
"ZH_SG",
"ZH_TW",
"ZU",
"ZU_ZA",
"AM",
"AM_ET",
"ARN",
"ARN_CL",
"AS",
"AS_IN",
"AZ_CYRL",
"AZ_CYRL_AZ",
"AZ_LATN",
"AZ_LATN_AZ",
"BA",
"BA_RU",
"BN",
"BN_BD",
"BN_IN",
"BO",
"BO_CN",
"BR",
"BR_FR",
"BS",
"BS_CYRL",
"BS_CYRL_BA",
"BS_LATN",
"BS_LATN_BA",
"CA_ES_VALENCIA",
"CHR",
"CHR_CHER",
"CHR_CHER_US",
"CO",
"CO_FR",
"DSB",
"DSB_DE",
"EN_029",
"EN_HK",
"EN_IN",
"EN_MY",
"EN_SG",
"ES_419",
"ES_US",
"FF",
"FF_LATN",
"FF_LATN_SN",
"FIL",
"FIL_PH",
"FR_CD",
"FR_CI",
"FR_CM",
"FR_HT",
"FR_MA",
"FR_ML",
"FR_RE",
"FR_SN",
"FY",
"FY_NL",
"GA",
"GA_IE",
"GD",
"GD_GB",
"GN",
"GN_PY",
"GSW",
"GSW_FR",
"HA",
"HA_LATN",
"HA_LATN_NG",
"HAW",
"HAW_US",
"HSB",
"HSB_DE",
"IG",
"IG_NG",
"II",
"II_CN",
"IU",
"IU_CANS",
"IU_CANS_CA",
"IU_LATN",
"IU_LATN_CA",
"JV",
"JV_LATN",
"JV_LATN_ID",
"KL",
"KL_GL",
"KM",
"KM_KH",
"KU",
"KU_ARAB",
"KU_ARAB_IQ",
"LB",
"LB_LU",
"LO",
"LO_LA",
"MG",
"MG_MG",
"ML",
"ML_IN",
"MN_CYRL",
"MN_MONG",
"MN_MONG_CN",
"MN_MONG_MN",
"MOH",
"MOH_CA",
"MY",
"MY_MM",
"NE",
"NE_IN",
"NE_NP",
"NN",
"NO",
"NQO",
"NQO_GN",
"NSO",
"NSO_ZA",
"OC",
"OC_FR",
"OM",
"OM_ET",
"OR",
"OR_IN",
"PA_ARAB",
"PA_ARAB_PK",
"PRS",
"PRS_AF",
"PS_AF",
"PT_AO",
"QUT",
"QUT_GT",
"QUZ",
"QUZ_BO",
"QUZ_EC",
"QUZ_PE",
"RM",
"RM_CH",
"RO_MD",
"RW",
"RW_RW",
"SAH",
"SAH_RU",
"SD",
"SD_ARAB",
"SD_ARAB_PK",
"SI",
"SI_LK",
"SMA",
"SMA_NO",
"SMA_SE",
"SMJ",
"SMJ_NO",
"SMJ_SE",
"SMN",
"SMN_FI",
"SMS",
"SMS_FI",
"SN",
"SN_LATN",
"SN_LATN_ZW",
"SO",
"SO_SO",
"SR",
"SR_CYRL",
"SR_CYRL_BA",
"SR_CYRL_CS",
"SR_CYRL_ME",
"SR_CYRL_RS",
"SR_LATN",
"SR_LATN_BA",
"SR_LATN_CS",
"SR_LATN_ME",
"SR_LATN_RS",
"ST",
"ST_ZA",
"TA_LK",
"TG",
"TG_CYRL",
"TG_CYRL_TJ",
"TI",
"TI_ER",
"TI_ET",
"TK",
"TK_TM",
"TN_BW",
"TS_ZA",
"TZM",
"TZM_LATN",
"TZM_LATN_DZ",
"TZM_TFNG",
"TZM_TFNG_MA",
"UG",
"UG_CN",
"UR_IN",
"UZ_CYRL",
"UZ_CYRL_UZ",
"UZ_LATN",
"UZ_LATN_UZ",
"WO",
"WO_SN",
"YO",
"YO_NG",
"ZGH",
"ZGH_TFNG",
"ZGH_TFNG_MA",
"ZH_HANS",
"ZH_HANT",
"ZH_CHS",
"ZH_CHT"
],
"type": "string",
"x-ms-enum": {
"name": "LanguageCode",
"modelAsString": false
}
},
"Text": {
"description": "The translated agreement.",
"maxLength": 204800,
"minLength": 0,
"type": "string"
},
"Header": {
"description": "The header for the translated agreement.",
"maxLength": 1000,
"minLength": 0,
"type": "string"
},
"IsDefault": {
"description": "If true, this translation is used as default.",
"type": "boolean"
}
}
},
"EnvelopeBulkSendAllowedSignatureTypes": {
"description": "The definition of the allowed signature types for the signature.",
"type": "object",
"properties": {
"ClickToSign": {
"$ref": "#/$defs/EnvelopeBulkSendClickToSignSignatureType",
"description": "Allow signing with \"click to sign\"."
},
"DrawToSign": {
"$ref": "#/$defs/EnvelopeBulkSendDrawToSignSignatureType",
"description": "Allow signing with \"draw to sign\"."
},
"TypeToSign": {
"$ref": "#/$defs/EnvelopeBulkSendTypeToSignSignatureType",
"description": "Allow signing with \"type to sign\"."
},
"LocalCertificate": {
"$ref": "#/$defs/EnvelopeBulkSendLocalCertificateSignatureType",
"description": "Allow signing with a local certificate."
},
"DisposableCertificate": {
"$ref": "#/$defs/EnvelopeBulkSendDisposableCertificateSignatureType",
"description": "Allow signing with a disposable certificate."
},
"SwissComOnDemand": {
"$ref": "#/$defs/EnvelopeBulkSendSwissComOnDemandSignatureType",
"description": "Allow signing with a Swisscom On-Demand certificate."
},
"ATrustCertificate": {
"$ref": "#/$defs/EnvelopeBulkSendATrustCertificateSignatureType",
"description": "Allow signing with an A-Trust certificate."
},
"Biometric": {
"$ref": "#/$defs/EnvelopeBulkSendBiometricSignatureType",
"description": "Allow signing with a biometric signature."
},
"RemoteCertificate": {
"$ref": "#/$defs/EnvelopeBulkSendRemoteCertificateSignatureType",
"description": "Allow signing with a remote certificate."
},
"OneTimePassword": {
"$ref": "#/$defs/EnvelopeBulkSendOneTimePasswordSignatureType",
"description": "Allow signing with a one time password (SMS-OTP)."
},
"SwedishBankId": {
"$ref": "#/$defs/EnvelopeBulkSendSwedishBankIdSignatureType",
"description": "Allow signing with Swedish BankID."
},
"SignaturePlugins": {
"description": "Allow signing with signature plugins.",
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendSignaturePluginSignatureType"
}
}
}
},
"EnvelopeBulkSendAppFinishAction": {
"description": "Define actions for different clients that will trigger after an action has been finished.",
"type": "object",
"properties": {
"RemoveDocumentFromRecentDocumentList": {
"description": "If true, the document will be removed from the recent document list.",
"type": "boolean"
},
"CallClientActionOnlyAfterSuccessfulSync": {
"description": "If true, the client action will be called only after a successful sync.",
"type": "boolean"
},
"CloseApp": {
"description": "If true, the app will be closed.",
"type": "boolean"
},
"RedirectUri": {
"description": "The redirect uri.",
"maxLength": 8000,
"minLength": 0,
"type": "string"
}
}
},
"EnvelopeBulkSendAttachment": {
"description": "The configuration of the attachment element.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Required": {
"description": "If true, the element is required.",
"type": "boolean"
},
"DisplayName": {
"description": "The displayed name.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"DisplayIconType": {
"description": "The type of the displayed icon. If no icon is provided Paperclip will be used.",
"enum": [
"Paperclip",
"Graph",
"PushPin",
"Tag"
],
"type": "string"
},
"GuidingOrder": {
"description": "The order of the element.",
"type": "integer"
},
"FieldDefinition": {
"$ref": "#/$defs/EnvelopeBulkSendAttachmentDefinition",
"description": "The definition of the attachment element.\nIt must be specified when the attachment element is added.\nIt must not be specified when the attachment element already exists."
}
}
},
"EnvelopeBulkSendAttachmentDefinition": {
"description": "The settings of a positionable element.",
"required": [
"Position",
"Size"
],
"type": "object",
"properties": {
"Position": {
"$ref": "#/$defs/EnvelopeBulkSendPosition",
"description": "The position of the element within the document."
},
"Size": {
"$ref": "#/$defs/EnvelopeBulkSendSize",
"description": "The size of the element."
}
}
},
"EnvelopeBulkSendAuthenticationConfiguration": {
"description": "The definition of the authentications of the recipient.",
"type": "object",
"properties": {
"AccessCode": {
"$ref": "#/$defs/EnvelopeBulkSendAccessCodeAuthentication",
"description": "The configuration of the authentication with an access code."
},
"SmsOneTimePassword": {
"$ref": "#/$defs/EnvelopeBulkSendSmsOneTimePasswordAuthentication",
"description": "The configuration of the authentication with one time password over SMS."
},
"SwedishBankId": {
"$ref": "#/$defs/EnvelopeBulkSendSwedishBankIdAuthentication",
"description": "The configuration of the authentication with Swedish BankID."
},
"OAuthAuthentications": {
"description": "The configurations of the authentication with OAuth.",
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendOAuthAuthentication"
}
},
"SamlAuthentications": {
"description": "The configurations of the authentication with SAML.",
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/$defs/EnvelopeBulkSendSamlAuthentication"
}
}
}
},
"EnvelopeBulkSendAuthenticationValidation": {
"description": "A validation rule for an authentication response.",
"type": "object",
"properties": {
"FieldReferenceId": {
"description": "The identifier of the field.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"ExpectedValue": {
"description": "The expected value of the field.",
"maxLength": 500,
"minLength": 0,
"type": "string"
}
}
},
"EnvelopeBulkSendBasicRecipientConfiguration": {
"description": "The configuration of the recipient.",
"required": [
"ContactInformation"
],
"type": "object",
"properties": {
"ContactInformation": {
"$ref": "#/$defs/EnvelopeBulkSendContactInformation",
"description": "The contact information of the recipient."
},
"PersonalMessage": {
"description": "The personal message for the recipient.",
"maxLength": 204800,
# --- truncated at 32 KB (148 KB total) ---
# Full source: https://artifacts.apis.io/namirial/json-schema/namirial-envelope-bulk-send-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-envelope-bulk-send-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.