{"items":[{"type":"link","label":"Namirial Sign Enterprise API","link":"/products/namirialsignenterprise/openapi3","routeSlug":"/products/namirialsignenterprise/openapi3","content":{"contentType":"overview","meta":{"name":"Namirial Sign Enterprise API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi3.json","url":"/_bundle/products/namirialsignenterprise/openapi3.json?download"},{"kind":"download","label":"openapi3.yaml","url":"/_bundle/products/namirialsignenterprise/openapi3.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Namirial Sign Enterprise API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Namirial Sign Enterprise API"}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Application Reference Data","link":"/products/namirialsignenterprise/openapi3/application-reference-data","routeSlug":"/products/namirialsignenterprise/openapi3/application-reference-data","items":[{"label":"List Application Languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/application-reference-data/listlanguages","routeSlug":"/products/namirialsignenterprise/openapi3/application-reference-data/listlanguages","metadata":{"seo":{"title":"List Application Languages","description":"Returns the languages supported by the application. Use the code values returned here when setting the languages of an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLanguages","name":"List Application Languages","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Application Languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the languages supported by the application. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values returned here when setting the languages of an organization."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/languages","servers":[{"url":"/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/languages","href":"application-reference-data/listlanguages","openApiOperationId":"listLanguages","summary":"List Application Languages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LanguageListResponse","exampleIds":["paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/LanguageListResponse","exampleIds":["paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LanguageListResponse","exampleIds":["paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LanguageListResponse","exampleIds":["paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-reference-data/listlanguages"}],"panels":[]}]},"httpPath":"/api/v1/languages"},{"label":"List countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/application-reference-data/listcountries","routeSlug":"/products/namirialsignenterprise/openapi3/application-reference-data/listcountries","metadata":{"seo":{"title":"List countries","description":"Returns the countries available for selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCountries","name":"List countries","isWebhook":false,"pointer":"/paths/~1api~1v1~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the countries available for selection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/countries","servers":[{"url":"/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/countries","href":"application-reference-data/listcountries","openApiOperationId":"listCountries","summary":"List countries","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountryListResponse","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CountryListResponse","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CountryListResponse","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountryListResponse","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-reference-data/listcountries"}],"panels":[]}]},"httpPath":"/api/v1/countries"},{"label":"List time zones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/application-reference-data/listtimezones","routeSlug":"/products/namirialsignenterprise/openapi3/application-reference-data/listtimezones","metadata":{"seo":{"title":"List time zones","description":"Returns the time zones available for selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTimeZones","name":"List time zones","isWebhook":false,"pointer":"/paths/~1api~1v1~1timezones/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List time zones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the time zones available for selection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/timezones","servers":[{"url":"/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/timezones","href":"application-reference-data/listtimezones","openApiOperationId":"listTimeZones","summary":"List time zones","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeZoneListResponse","exampleIds":["paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TimeZoneListResponse","exampleIds":["paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1timezones/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimeZoneListResponse","exampleIds":["paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeZoneListResponse","exampleIds":["paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-reference-data/listtimezones"}],"panels":[]}]},"httpPath":"/api/v1/timezones"},{"label":"List date-time formats","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/application-reference-data/listdatetimeformats","routeSlug":"/products/namirialsignenterprise/openapi3/application-reference-data/listdatetimeformats","metadata":{"seo":{"title":"List date-time formats","description":"Returns the date-time formats available for selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDateTimeFormats","name":"List date-time formats","isWebhook":false,"pointer":"/paths/~1api~1v1~1datetime-formats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List date-time formats","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the date-time formats available for selection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/datetime-formats","servers":[{"url":"/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/datetime-formats","href":"application-reference-data/listdatetimeformats","openApiOperationId":"listDateTimeFormats","summary":"List date-time formats","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DateTimeFormatListResponse","exampleIds":["paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DateTimeFormatListResponse","exampleIds":["paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1datetime-formats/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DateTimeFormatListResponse","exampleIds":["paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DateTimeFormatListResponse","exampleIds":["paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-reference-data/listdatetimeformats"}],"panels":[]}]},"httpPath":"/api/v1/datetime-formats"}],"content":{"contentType":"group","meta":{"name":"Application Reference Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Reference Data","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/languages","summary":"List Application Languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-reference-data/listlanguages","deprecated":false},{"title":"/api/v1/countries","summary":"List countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-reference-data/listcountries","deprecated":false},{"title":"/api/v1/timezones","summary":"List time zones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-reference-data/listtimezones","deprecated":false},{"title":"/api/v1/datetime-formats","summary":"List date-time formats","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-reference-data/listdatetimeformats","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope","link":"/products/namirialsignenterprise/openapi3/bulk-envelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope","items":[{"label":"List bulk envelopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope/listbulkenvelopes","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope/listbulkenvelopes","metadata":{"seo":{"title":"List bulk envelopes","description":"Returns a paginated list of bulk envelope parents for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkEnvelopes","name":"List bulk envelopes","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk envelopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of bulk envelope parents for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1","description":"Filter bulk envelopes updated before this date."},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1","description":"Filter bulk envelopes updated after this date."},{"name":"SentBefore","in":"query","schemaId":"schema_1","description":"Filter bulk envelopes sent before this date."},{"name":"SentAfter","in":"query","schemaId":"schema_1","description":"Filter bulk envelopes sent after this date."},{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SortingKey","in":"query","schemaId":"schema_3","description":"The sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Whether to sort in ascending order."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1"},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1"},{"name":"SentBefore","in":"query","schemaId":"schema_1"},{"name":"SentAfter","in":"query","schemaId":"schema_1"},{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/BulkEnvelopeSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes","href":"bulk-envelope/listbulkenvelopes","openApiOperationId":"listBulkEnvelopes","summary":"List bulk envelopes","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope/listbulkenvelopes"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes"},{"label":"Create bulk envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope/createbulkenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope/createbulkenvelope","metadata":{"seo":{"title":"Create bulk envelope","description":"Creates a new bulk envelope parent in draft status within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBulkEnvelope","name":"Create bulk envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bulk envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new bulk envelope parent in draft status within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/CreateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/bulk-envelopes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes","href":"bulk-envelope/createbulkenvelope","openApiOperationId":"createBulkEnvelope","summary":"Create bulk envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateBulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope/createbulkenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes"},{"label":"Get bulk envelope","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope/getbulkenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope/getbulkenvelope","metadata":{"seo":{"title":"Get bulk envelope","description":"Returns a specific bulk envelope parent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkEnvelope","name":"Get bulk envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific bulk envelope parent."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","href":"bulk-envelope/getbulkenvelope","openApiOperationId":"getBulkEnvelope","summary":"Get bulk envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/BulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope/getbulkenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}"},{"label":"Update bulk envelope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope/updatebulkenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope/updatebulkenvelope","metadata":{"seo":{"title":"Update bulk envelope","description":"Updates a specific bulk envelope parent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkEnvelope","name":"Update bulk envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific bulk envelope parent."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/UpdateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","href":"bulk-envelope/updatebulkenvelope","openApiOperationId":"updateBulkEnvelope","summary":"Update bulk envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope/updatebulkenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}"},{"label":"Delete bulk envelope","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope/deletebulkenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope/deletebulkenvelope","metadata":{"seo":{"title":"Delete bulk envelope","description":"Deletes a specific bulk envelope parent and its related child envelopes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBulkEnvelope","name":"Delete bulk envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete bulk envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific bulk envelope parent and its related child envelopes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","href":"bulk-envelope/deletebulkenvelope","openApiOperationId":"deleteBulkEnvelope","summary":"Delete bulk envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope/deletebulkenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes","summary":"List bulk envelopes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope/listbulkenvelopes","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes","summary":"Create bulk envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-envelope/createbulkenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","summary":"Get bulk envelope","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope/getbulkenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","summary":"Update bulk envelope","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-envelope/updatebulkenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}","summary":"Delete bulk envelope","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-envelope/deletebulkenvelope","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope Action","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-action","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-action","items":[{"label":"Send bulk envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-action/sendbulkenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-action/sendbulkenvelope","metadata":{"seo":{"title":"Send bulk envelope","description":"Sends the bulk envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendBulkEnvelope","name":"Send bulk envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1send/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send bulk envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends the bulk envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1send/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/send","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/send","href":"bulk-envelope-action/sendbulkenvelope","openApiOperationId":"sendBulkEnvelope","summary":"Send bulk envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1send/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-action/sendbulkenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/send"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope Action"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope Action","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/send","summary":"Send bulk envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-envelope-action/sendbulkenvelope","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope Detail","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-detail","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-detail","items":[{"label":"List bulk envelope child envelopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-detail/listbulkenvelopechildenvelopes","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-detail/listbulkenvelopechildenvelopes","metadata":{"seo":{"title":"List bulk envelope child envelopes","description":"Returns a paginated list of the child envelopes generated by sending the specified bulk envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkEnvelopeChildEnvelopes","name":"List bulk envelope child envelopes","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk envelope child envelopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of the child envelopes generated by sending the specified bulk envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Whether to sort in ascending order."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/envelopes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/envelopes","href":"bulk-envelope-detail/listbulkenvelopechildenvelopes","openApiOperationId":"listBulkEnvelopeChildEnvelopes","summary":"List bulk envelope child envelopes","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeChildEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeChildEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeChildEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeChildEnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-detail/listbulkenvelopechildenvelopes"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/envelopes"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope Detail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope Detail","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/envelopes","summary":"List bulk envelope child envelopes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-detail/listbulkenvelopechildenvelopes","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope File","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file","items":[{"label":"List bulk-envelope files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/listbulkenvelopefiles","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/listbulkenvelopefiles","metadata":{"seo":{"title":"List bulk-envelope files","description":"Returns the files of the specified bulk-envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkEnvelopeFiles","name":"List bulk-envelope files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk-envelope files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the files of the specified bulk-envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","href":"bulk-envelope-file/listbulkenvelopefiles","openApiOperationId":"listBulkEnvelopeFiles","summary":"List bulk-envelope files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/listbulkenvelopefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files"},{"label":"Upload bulk-envelope file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/uploadbulkenvelopefile","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/uploadbulkenvelopefile","metadata":{"seo":{"title":"Upload bulk-envelope file","description":"Adds a new file to the specified bulk-envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadBulkEnvelopeFile","name":"Upload bulk-envelope file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload bulk-envelope file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new file to the specified bulk-envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_5","encoding":{"file":{"style":"form"},"documentClassId":{"style":"form"}}}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","href":"bulk-envelope-file/uploadbulkenvelopefile","openApiOperationId":"uploadBulkEnvelopeFile","summary":"Upload bulk-envelope file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_5","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadBulkEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/UploadBulkEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/UploadBulkEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadBulkEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/uploadbulkenvelopefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files"},{"label":"Reorder bulk-envelope files","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/reorderbulkenvelopefiles","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/reorderbulkenvelopefiles","metadata":{"seo":{"title":"Reorder bulk-envelope files","description":"Reorders the files of the specified bulk-envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderBulkEnvelopeFiles","name":"Reorder bulk-envelope files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder bulk-envelope files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the files of the specified bulk-envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchBulkEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","href":"bulk-envelope-file/reorderbulkenvelopefiles","openApiOperationId":"reorderBulkEnvelopeFiles","summary":"Reorder bulk-envelope files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchBulkEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/reorderbulkenvelopefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files"},{"label":"Get bulk-envelope file properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/getbulkenvelopefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/getbulkenvelopefiledetail","metadata":{"seo":{"title":"Get bulk-envelope file properties","description":"Returns the properties of a specific bulk-envelope file, including the assigned document class and its metadata values. Does not include the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkEnvelopeFileDetail","name":"Get bulk-envelope file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk-envelope file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the properties of a specific bulk-envelope file, including the assigned document class and its metadata values. Does not include the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","href":"bulk-envelope-file/getbulkenvelopefiledetail","openApiOperationId":"getBulkEnvelopeFileDetail","summary":"Get bulk-envelope file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/getbulkenvelopefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}"},{"label":"Update bulk-envelope file properties","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/updatebulkenvelopefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/updatebulkenvelopefiledetail","metadata":{"seo":{"title":"Update bulk-envelope file properties","description":"Updates the properties of a specific bulk-envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkEnvelopeFileDetail","name":"Update bulk-envelope file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk-envelope file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the properties of a specific bulk-envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","href":"bulk-envelope-file/updatebulkenvelopefiledetail","openApiOperationId":"updateBulkEnvelopeFileDetail","summary":"Update bulk-envelope file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/updatebulkenvelopefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}"},{"label":"Delete bulk-envelope file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/deletebulkenvelopefile","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file/deletebulkenvelopefile","metadata":{"seo":{"title":"Delete bulk-envelope file","description":"Deletes a specific file from the specified bulk-envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBulkEnvelopeFile","name":"Delete bulk-envelope file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete bulk-envelope file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific file from the specified bulk-envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","href":"bulk-envelope-file/deletebulkenvelopefile","openApiOperationId":"deleteBulkEnvelopeFile","summary":"Delete bulk-envelope file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file/deletebulkenvelopefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope File","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","summary":"List bulk-envelope files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-file/listbulkenvelopefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","summary":"Upload bulk-envelope file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-envelope-file/uploadbulkenvelopefile","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files","summary":"Reorder bulk-envelope files","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/bulk-envelope-file/reorderbulkenvelopefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","summary":"Get bulk-envelope file properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-file/getbulkenvelopefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","summary":"Update bulk-envelope file properties","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-envelope-file/updatebulkenvelopefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}","summary":"Delete bulk-envelope file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-envelope-file/deletebulkenvelopefile","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope File Task","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task","items":[{"label":"List bulk-envelope file tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/listbulkenvelopefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/listbulkenvelopefiletasks","metadata":{"seo":{"title":"List bulk-envelope file tasks","description":"Returns the tasks of a specific bulk-envelope file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkEnvelopeFileTasks","name":"List bulk-envelope file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk-envelope file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tasks of a specific bulk-envelope file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","href":"bulk-envelope-file-task/listbulkenvelopefiletasks","openApiOperationId":"listBulkEnvelopeFileTasks","summary":"List bulk-envelope file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeFieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeFieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeFieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file-task/listbulkenvelopefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks"},{"label":"Update bulk-envelope file tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/updatebulkenvelopefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/updatebulkenvelopefiletasks","metadata":{"seo":{"title":"Update bulk-envelope file tasks","description":"Replaces the tasks of a specific bulk-envelope file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkEnvelopeFileTasks","name":"Update bulk-envelope file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk-envelope file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the tasks of a specific bulk-envelope file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"schemaId":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","href":"bulk-envelope-file-task/updatebulkenvelopefiletasks","openApiOperationId":"updateBulkEnvelopeFileTasks","summary":"Update bulk-envelope file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-file-task/updatebulkenvelopefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope File Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope File Task","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","summary":"List bulk-envelope file tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-file-task/listbulkenvelopefiletasks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks","summary":"Update bulk-envelope file tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-envelope-file-task/updatebulkenvelopefiletasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope Stage","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage","items":[{"label":"List bulk envelope stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/listbulkenvelopestages","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/listbulkenvelopestages","metadata":{"seo":{"title":"List bulk envelope stages","description":"Returns the stages of the specified bulk envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkEnvelopeStages","name":"List bulk envelope stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bulk envelope stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the stages of the specified bulk envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","href":"bulk-envelope-stage/listbulkenvelopestages","openApiOperationId":"listBulkEnvelopeStages","summary":"List bulk envelope stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/listbulkenvelopestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages"},{"label":"Create bulk envelope stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/createbulkenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/createbulkenvelopestage","metadata":{"seo":{"title":"Create bulk envelope stage","description":"Creates a new stage for the specified bulk envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBulkEnvelopeStage","name":"Create bulk envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bulk envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new stage for the specified bulk envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"]}},"schemaId":"components/schemas/CreateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","href":"bulk-envelope-stage/createbulkenvelopestage","openApiOperationId":"createBulkEnvelopeStage","summary":"Create bulk envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateBulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/createbulkenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages"},{"label":"Reorder bulk envelope stages","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/reorderbulkenvelopestages","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/reorderbulkenvelopestages","metadata":{"seo":{"title":"Reorder bulk envelope stages","description":"Reorders the stages of the specified bulk envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderBulkEnvelopeStages","name":"Reorder bulk envelope stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder bulk envelope stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the stages of the specified bulk envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchBulkEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","href":"bulk-envelope-stage/reorderbulkenvelopestages","openApiOperationId":"reorderBulkEnvelopeStages","summary":"Reorder bulk envelope stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchBulkEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchBulkEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/reorderbulkenvelopestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages"},{"label":"Get bulk envelope stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/getbulkenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/getbulkenvelopestage","metadata":{"seo":{"title":"Get bulk envelope stage","description":"Returns a specific bulk envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkEnvelopeStage","name":"Get bulk envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific bulk envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","href":"bulk-envelope-stage/getbulkenvelopestage","openApiOperationId":"getBulkEnvelopeStage","summary":"Get bulk envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/getbulkenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}"},{"label":"Update bulk envelope stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/updatebulkenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/updatebulkenvelopestage","metadata":{"seo":{"title":"Update bulk envelope stage","description":"Updates a specific bulk envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkEnvelopeStage","name":"Update bulk envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific bulk envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"schemaId":"components/schemas/UpdateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","href":"bulk-envelope-stage/updatebulkenvelopestage","openApiOperationId":"updateBulkEnvelopeStage","summary":"Update bulk envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBulkEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/updatebulkenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}"},{"label":"Delete bulk envelope stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/deletebulkenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage/deletebulkenvelopestage","metadata":{"seo":{"title":"Delete bulk envelope stage","description":"Deletes a specific bulk envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBulkEnvelopeStage","name":"Delete bulk envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete bulk envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific bulk envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","href":"bulk-envelope-stage/deletebulkenvelopestage","openApiOperationId":"deleteBulkEnvelopeStage","summary":"Delete bulk envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage/deletebulkenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope Stage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope Stage","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","summary":"List bulk envelope stages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-stage/listbulkenvelopestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","summary":"Create bulk envelope stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-envelope-stage/createbulkenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages","summary":"Reorder bulk envelope stages","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/bulk-envelope-stage/reorderbulkenvelopestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","summary":"Get bulk envelope stage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-stage/getbulkenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","summary":"Update bulk envelope stage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-envelope-stage/updatebulkenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}","summary":"Delete bulk envelope stage","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-envelope-stage/deletebulkenvelopestage","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Envelope Stage Recipient","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient","items":[{"label":"Create bulk envelope stage recipient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/createbulkenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/createbulkenvelopestagerecipient","metadata":{"seo":{"title":"Create bulk envelope stage recipient","description":"Creates a new recipient for the specified bulk envelope stage. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic recipients with 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBulkEnvelopeStageRecipient","name":"Create bulk envelope stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bulk envelope stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new recipient for the specified bulk envelope stage. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic recipients with 422."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_6","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients","href":"bulk-envelope-stage-recipient/createbulkenvelopestagerecipient","openApiOperationId":"createBulkEnvelopeStageRecipient","summary":"Create bulk envelope stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_6","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateBulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage-recipient/createbulkenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients"},{"label":"Get bulk envelope stage recipient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/getbulkenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/getbulkenvelopestagerecipient","metadata":{"seo":{"title":"Get bulk envelope stage recipient","description":"Returns a specific bulk envelope stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkEnvelopeStageRecipient","name":"Get bulk envelope stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk envelope stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific bulk envelope stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","href":"bulk-envelope-stage-recipient/getbulkenvelopestagerecipient","openApiOperationId":"getBulkEnvelopeStageRecipient","summary":"Get bulk envelope stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkEnvelopeStageRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage-recipient/getbulkenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Update bulk envelope stage recipient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient","metadata":{"seo":{"title":"Update bulk envelope stage recipient","description":"Updates a specific bulk envelope stage recipient. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic recipients with 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkEnvelopeStageRecipient","name":"Update bulk envelope stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update bulk envelope stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific bulk envelope stage recipient. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic recipients with 422."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_7","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","href":"bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient","openApiOperationId":"updateBulkEnvelopeStageRecipient","summary":"Update bulk envelope stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_7","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Delete bulk envelope stage recipient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient","metadata":{"seo":{"title":"Delete bulk envelope stage recipient","description":"Deletes a specific bulk envelope stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBulkEnvelopeStageRecipient","name":"Delete bulk envelope stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete bulk envelope stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific bulk envelope stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"bulkEnvelopeId","in":"path","schemaId":"schema_0","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"bulkEnvelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","href":"bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient","openApiOperationId":"deleteBulkEnvelopeStageRecipient","summary":"Delete bulk envelope stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}"}],"content":{"contentType":"group","meta":{"name":"Bulk Envelope Stage Recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Envelope Stage Recipient","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients","summary":"Create bulk envelope stage recipient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-envelope-stage-recipient/createbulkenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Get bulk envelope stage recipient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-envelope-stage-recipient/getbulkenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Update bulk envelope stage recipient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Delete bulk envelope stage recipient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient","deprecated":false}]}]}]}]}},{"type":"group","label":"Document Class","link":"/products/namirialsignenterprise/openapi3/document-class","routeSlug":"/products/namirialsignenterprise/openapi3/document-class","items":[{"label":"List document classes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-class/listdocumentclasses","routeSlug":"/products/namirialsignenterprise/openapi3/document-class/listdocumentclasses","metadata":{"seo":{"title":"List document classes","description":"Returns a paginated list of document classes for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDocumentClasses","name":"List document classes","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List document classes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of document classes for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/document-classes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-classes","href":"document-class/listdocumentclasses","openApiOperationId":"listDocumentClasses","summary":"List document classes","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentClassListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DocumentClassListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentClassListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentClassListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-class/listdocumentclasses"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-classes"},{"label":"Create document class","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-class/createdocumentclass","routeSlug":"/products/namirialsignenterprise/openapi3/document-class/createdocumentclass","metadata":{"seo":{"title":"Create document class","description":"Creates a new document class with the specified name, optional description, and metadata references. Metadata definitions are managed through the document metadata endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDocumentClass","name":"Create document class","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create document class","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new document class with the specified name, optional description, and metadata references. Metadata definitions are managed through the document metadata endpoints."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/document-classes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-classes","href":"document-class/createdocumentclass","openApiOperationId":"createDocumentClass","summary":"Create document class","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateDocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateDocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-class/createdocumentclass"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-classes"},{"label":"Get document class","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-class/getdocumentclass","routeSlug":"/products/namirialsignenterprise/openapi3/document-class/getdocumentclass","metadata":{"seo":{"title":"Get document class","description":"Returns the name, description, and full metadata field data of the specified document class."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentClass","name":"Get document class","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document class","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the name, description, and full metadata field data of the specified document class."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"documentClassId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"documentClassId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","href":"document-class/getdocumentclass","openApiOperationId":"getDocumentClass","summary":"Get document class","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentClassResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-class/getdocumentclass"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}"},{"label":"Update document class","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-class/updatedocumentclass","routeSlug":"/products/namirialsignenterprise/openapi3/document-class/updatedocumentclass","metadata":{"seo":{"title":"Update document class","description":"Updates the name, description, and metadata references of the specified document class. Metadata definitions are managed through the document metadata endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDocumentClass","name":"Update document class","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update document class","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the name, description, and metadata references of the specified document class. Metadata definitions are managed through the document metadata endpoints."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"documentClassId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"documentClassId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","href":"document-class/updatedocumentclass","openApiOperationId":"updateDocumentClass","summary":"Update document class","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDocumentClassRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-class/updatedocumentclass"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}"},{"label":"Delete document class","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-class/deletedocumentclass","routeSlug":"/products/namirialsignenterprise/openapi3/document-class/deletedocumentclass","metadata":{"seo":{"title":"Delete document class","description":"Deletes the specified document class."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDocumentClass","name":"Delete document class","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete document class","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified document class."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"documentClassId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"documentClassId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","href":"document-class/deletedocumentclass","openApiOperationId":"deleteDocumentClass","summary":"Delete document class","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-class/deletedocumentclass"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}"}],"content":{"contentType":"group","meta":{"name":"Document Class"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Class","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/document-classes","summary":"List document classes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-class/listdocumentclasses","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-classes","summary":"Create document class","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document-class/createdocumentclass","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","summary":"Get document class","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-class/getdocumentclass","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","summary":"Update document class","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document-class/updatedocumentclass","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-classes/{documentClassId}","summary":"Delete document class","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/document-class/deletedocumentclass","deprecated":false}]}]}]}]}},{"type":"group","label":"Document Metadata","link":"/products/namirialsignenterprise/openapi3/document-metadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata","items":[{"label":"List document metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/listdocumentmetadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/listdocumentmetadata","metadata":{"seo":{"title":"List document metadata","description":"Returns a paginated list of document metadata fields for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDocumentMetadata","name":"List document metadata","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of document metadata fields for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_8","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_9","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/document-metadata","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","example":1,"schemaId":"schema_8"},{"name":"PageSize","in":"query","example":20,"schemaId":"schema_9"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata","href":"document-metadata/listdocumentmetadata","openApiOperationId":"listDocumentMetadata","summary":"List document metadata","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentMetadataListResult","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DocumentMetadataListResult","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentMetadataListResult","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentMetadataListResult","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/listdocumentmetadata"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata"},{"label":"Create document metadata","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/createdocumentmetadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/createdocumentmetadata","metadata":{"seo":{"title":"Create document metadata","description":"Creates a new document metadata field for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDocumentMetadata","name":"Create document metadata","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new document metadata field for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"]}},"schemaId":"schema_10","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/document-metadata","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata","href":"document-metadata/createdocumentmetadata","openApiOperationId":"createDocumentMetadata","summary":"Create document metadata","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_10","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/createdocumentmetadata"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata"},{"label":"Get document metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadata","metadata":{"seo":{"title":"Get document metadata","description":"Returns the specified document metadata field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentMetadata","name":"Get document metadata","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the specified document metadata field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"metadataId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"metadataId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","href":"document-metadata/getdocumentmetadata","openApiOperationId":"getDocumentMetadata","summary":"Get document metadata","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/getdocumentmetadata"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}"},{"label":"Update document metadata","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/updatedocumentmetadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/updatedocumentmetadata","metadata":{"seo":{"title":"Update document metadata","description":"Updates the specified document metadata field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDocumentMetadata","name":"Update document metadata","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the specified document metadata field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"metadataId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"]}},"schemaId":"schema_13","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"metadataId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","href":"document-metadata/updatedocumentmetadata","openApiOperationId":"updateDocumentMetadata","summary":"Update document metadata","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_13","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType","paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/updatedocumentmetadata"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}"},{"label":"Delete document metadata","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/deletedocumentmetadata","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/deletedocumentmetadata","metadata":{"seo":{"title":"Delete document metadata","description":"Deletes the specified document metadata field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDocumentMetadata","name":"Delete document metadata","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete document metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified document metadata field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"metadataId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"metadataId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","href":"document-metadata/deletedocumentmetadata","openApiOperationId":"deleteDocumentMetadata","summary":"Delete document metadata","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/deletedocumentmetadata"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}"},{"label":"Get eligible parent metadata fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadataeligibleparents","routeSlug":"/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadataeligibleparents","metadata":{"seo":{"title":"Get eligible parent metadata fields","description":"Returns the list-option document metadata fields eligible to be set as the parent of the specified field (excludes the field itself and its own children, to avoid cyclic dependencies)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentMetadataEligibleParents","name":"Get eligible parent metadata fields","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}~1eligible-parents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eligible parent metadata fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list-option document metadata fields eligible to be set as the parent of the specified field (excludes the field itself and its own children, to avoid cyclic dependencies)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"metadataId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}~1eligible-parents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}/eligible-parents","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"metadataId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}/eligible-parents","href":"document-metadata/getdocumentmetadataeligibleparents","openApiOperationId":"getDocumentMetadataEligibleParents","summary":"Get eligible parent metadata fields","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EligibleParentsResponse"}},"schemaId":"components/schemas/EligibleParentsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}~1eligible-parents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EligibleParentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EligibleParentsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-metadata/getdocumentmetadataeligibleparents"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}/eligible-parents"}],"content":{"contentType":"group","meta":{"name":"Document Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Metadata","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/document-metadata","summary":"List document metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-metadata/listdocumentmetadata","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-metadata","summary":"Create document metadata","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document-metadata/createdocumentmetadata","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","summary":"Get document metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-metadata/getdocumentmetadata","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","summary":"Update document metadata","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document-metadata/updatedocumentmetadata","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}","summary":"Delete document metadata","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/document-metadata/deletedocumentmetadata","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/document-metadata/{metadataId}/eligible-parents","summary":"Get eligible parent metadata fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-metadata/getdocumentmetadataeligibleparents","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope","link":"/products/namirialsignenterprise/openapi3/envelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope","items":[{"label":"List envelopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope/listenvelopes","routeSlug":"/products/namirialsignenterprise/openapi3/envelope/listenvelopes","metadata":{"seo":{"title":"List envelopes","description":"Returns a paginated list of envelopes for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopes","name":"List envelopes","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of envelopes for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1","description":"Filter envelopes updated before this date."},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1","description":"Filter envelopes updated after this date."},{"name":"SentBefore","in":"query","schemaId":"schema_1","description":"Filter envelopes sent before this date."},{"name":"SentAfter","in":"query","schemaId":"schema_1","description":"Filter envelopes sent after this date."},{"name":"Status","in":"query","schemaId":"schema_14","description":"Filter envelopes by status."},{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SortingKey","in":"query","schemaId":"schema_15","description":"The sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Whether to sort in ascending order."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1"},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1"},{"name":"SentBefore","in":"query","schemaId":"schema_1"},{"name":"SentAfter","in":"query","schemaId":"schema_1"},{"name":"Status","in":"query","schemaId":"components/schemas/EnvelopeStatusFilter"},{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/EnvelopeSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes","href":"envelope/listenvelopes","openApiOperationId":"listEnvelopes","summary":"List envelopes","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope/listenvelopes"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes"},{"label":"Create envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope/createenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope/createenvelope","metadata":{"seo":{"title":"Create envelope","description":"Creates a new envelope in draft status within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnvelope","name":"Create envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new envelope in draft status within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/CreateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes","href":"envelope/createenvelope","openApiOperationId":"createEnvelope","summary":"Create envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope/createenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes"},{"label":"Get envelope","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope/getenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope/getenvelope","metadata":{"seo":{"title":"Get envelope","description":"Returns a specific envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelope","name":"Get envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","href":"envelope/getenvelope","openApiOperationId":"getEnvelope","summary":"Get envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/EnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope/getenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}"},{"label":"Update envelope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope/updateenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope/updateenvelope","metadata":{"seo":{"title":"Update envelope","description":"Updates a specific envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelope","name":"Update envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/UpdateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","href":"envelope/updateenvelope","openApiOperationId":"updateEnvelope","summary":"Update envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope/updateenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}"},{"label":"Delete envelope","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope/deleteenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope/deleteenvelope","metadata":{"seo":{"title":"Delete envelope","description":"Deletes a specific envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnvelope","name":"Delete envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","href":"envelope/deleteenvelope","openApiOperationId":"deleteEnvelope","summary":"Delete envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope/deleteenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}"}],"content":{"contentType":"group","meta":{"name":"Envelope"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing envelopes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes","summary":"List envelopes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope/listenvelopes","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes","summary":"Create envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope/createenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","summary":"Get envelope","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope/getenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","summary":"Update envelope","prefix":{"name":"put","color":"put"},"badges":[],"link":"/envelope/updateenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}","summary":"Delete envelope","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/envelope/deleteenvelope","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope Action","link":"/products/namirialsignenterprise/openapi3/envelope-action","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action","items":[{"label":"Send envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/sendenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/sendenvelope","metadata":{"seo":{"title":"Send envelope","description":"Sends the envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendEnvelope","name":"Send envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends the envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send","href":"envelope-action/sendenvelope","openApiOperationId":"sendEnvelope","summary":"Send envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/sendenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send"},{"label":"Send envelope reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/sendenvelopereminder","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/sendenvelopereminder","metadata":{"seo":{"title":"Send envelope reminder","description":"Sends a reminder notification to pending recipients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendEnvelopeReminder","name":"Send envelope reminder","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send-reminder/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send envelope reminder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends a reminder notification to pending recipients."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send-reminder/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send-reminder","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send-reminder","href":"envelope-action/sendenvelopereminder","openApiOperationId":"sendEnvelopeReminder","summary":"Send envelope reminder","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1send-reminder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/sendenvelopereminder"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send-reminder"},{"label":"Resume envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/resumeenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/resumeenvelope","metadata":{"seo":{"title":"Resume envelope","description":"Resumes an envelope that was previously in an expired state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resumeEnvelope","name":"Resume envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resumes an envelope that was previously in an expired state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResumeEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ResumeEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/resume","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResumeEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/resume","href":"envelope-action/resumeenvelope","openApiOperationId":"resumeEnvelope","summary":"Resume envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/ResumeEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResumeEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/resumeenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/resume"},{"label":"Cancel envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/cancelenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/cancelenvelope","metadata":{"seo":{"title":"Cancel envelope","description":"Cancels an in-progress envelope, stopping the signing workflow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelEnvelope","name":"Cancel envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an in-progress envelope, stopping the signing workflow."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CancelEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/cancel","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/cancel","href":"envelope-action/cancelenvelope","openApiOperationId":"cancelEnvelope","summary":"Cancel envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CancelEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelEnvelopeRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/cancelenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/cancel"},{"label":"Clone envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/cloneenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/cloneenvelope","metadata":{"seo":{"title":"Clone envelope","description":"Creates a new draft envelope by cloning an existing envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloneEnvelope","name":"Clone envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new draft envelope by cloning an existing envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/clone","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/clone","href":"envelope-action/cloneenvelope","openApiOperationId":"cloneEnvelope","summary":"Clone envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloneEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CloneEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CloneEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloneEnvelopeResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/cloneenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/clone"},{"label":"Apply policies on envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/applypoliciesonenvelope","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/applypoliciesonenvelope","metadata":{"seo":{"title":"Apply policies on envelope","description":"Applies policies on an existing envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyPoliciesOnEnvelope","name":"Apply policies on envelope","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1apply-policies/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply policies on envelope","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applies policies on an existing envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1apply-policies/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/apply-policies","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/apply-policies","href":"envelope-action/applypoliciesonenvelope","openApiOperationId":"applyPoliciesOnEnvelope","summary":"Apply policies on envelope","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1apply-policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/applypoliciesonenvelope"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/apply-policies"},{"label":"Verify envelope policies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-action/verifyenvelopepolicies","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-action/verifyenvelopepolicies","metadata":{"seo":{"title":"Verify envelope policies","description":"Checks whether the envelope satisfies all applicable document class policies without modifying its state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyEnvelopePolicies","name":"Verify envelope policies","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify envelope policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks whether the envelope satisfies all applicable document class policies without modifying its state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/verify-policies","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/verify-policies","href":"envelope-action/verifyenvelopepolicies","openApiOperationId":"verifyEnvelopePolicies","summary":"Verify envelope policies","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyEnvelopePoliciesResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/VerifyEnvelopePoliciesResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerifyEnvelopePoliciesResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerifyEnvelopePoliciesResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-action/verifyenvelopepolicies"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/verify-policies"}],"content":{"contentType":"group","meta":{"name":"Envelope Action"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope Action","showPageActions":true},{"nodeType":"markdoc","content":"Actions to control the envelope lifecycle."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send","summary":"Send envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/sendenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send-reminder","summary":"Send envelope reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/sendenvelopereminder","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/resume","summary":"Resume envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/resumeenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/cancel","summary":"Cancel envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/cancelenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/clone","summary":"Clone envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/cloneenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/apply-policies","summary":"Apply policies on envelope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/applypoliciesonenvelope","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/verify-policies","summary":"Verify envelope policies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-action/verifyenvelopepolicies","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope Detail","link":"/products/namirialsignenterprise/openapi3/envelope-detail","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-detail","items":[{"label":"List envelope events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeevents","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeevents","metadata":{"seo":{"title":"List envelope events","description":"Returns the events of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeEvents","name":"List envelope events","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelope events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the events of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/events","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/events","href":"envelope-detail/listenvelopeevents","openApiOperationId":"listEnvelopeEvents","summary":"List envelope events","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeEventListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeEventListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeEventListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeEventListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-detail/listenvelopeevents"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/events"},{"label":"List next recipient links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-detail/listnextrecipientlinks","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-detail/listnextrecipientlinks","metadata":{"seo":{"title":"List next recipient links","description":"Returns the next recipients in the signing workflow with their action links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNextRecipientLinks","name":"List next recipient links","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List next recipient links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the next recipients in the signing workflow with their action links."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/next-recipient-links","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/next-recipient-links","href":"envelope-detail/listnextrecipientlinks","openApiOperationId":"listNextRecipientLinks","summary":"List next recipient links","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NextRecipientLinksResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/NextRecipientLinksResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NextRecipientLinksResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NextRecipientLinksResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-detail/listnextrecipientlinks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/next-recipient-links"},{"label":"List envelope artifacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeartifacts","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeartifacts","metadata":{"seo":{"title":"List envelope artifacts","description":"Returns the artifacts of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeArtifacts","name":"List envelope artifacts","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelope artifacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the artifacts of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts","href":"envelope-detail/listenvelopeartifacts","openApiOperationId":"listEnvelopeArtifacts","summary":"List envelope artifacts","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeArtifactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeArtifactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeArtifactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeArtifactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-detail/listenvelopeartifacts"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts"},{"label":"Get envelope artifact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-detail/getenvelopeartifact","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-detail/getenvelopeartifact","metadata":{"seo":{"title":"Get envelope artifact","description":"Returns a specific envelope artifact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelopeArtifact","name":"Get envelope artifact","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts~1{artifactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get envelope artifact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific envelope artifact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"artifactId","in":"path","schemaId":"schema_0","description":"Unique identifier of the artifact","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts~1{artifactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"artifactId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}","href":"envelope-detail/getenvelopeartifact","openApiOperationId":"getEnvelopeArtifact","summary":"Get envelope artifact","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the binary content of the file.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_16"}},"schemaId":"schema_16","headers":{"Content-Disposition":{"description":"Suggested filename for the downloaded file.","schema":{"type":"string","example":"attachment; filename=\"file\""}}},"headerSchemaId":"schema_17"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts~1{artifactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_16"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-detail/getenvelopeartifact"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}"}],"content":{"contentType":"group","meta":{"name":"Envelope Detail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope Detail","showPageActions":true},{"nodeType":"markdoc","content":"Events and artifacts of an envelope."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/events","summary":"List envelope events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-detail/listenvelopeevents","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/next-recipient-links","summary":"List next recipient links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-detail/listnextrecipientlinks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts","summary":"List envelope artifacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-detail/listenvelopeartifacts","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}","summary":"Get envelope artifact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-detail/getenvelopeartifact","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope File","link":"/products/namirialsignenterprise/openapi3/envelope-file","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file","items":[{"label":"List envelope files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/listenvelopefiles","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/listenvelopefiles","metadata":{"seo":{"title":"List envelope files","description":"Returns the files of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeFiles","name":"List envelope files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelope files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the files of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","href":"envelope-file/listenvelopefiles","openApiOperationId":"listEnvelopeFiles","summary":"List envelope files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/listenvelopefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files"},{"label":"Upload envelope file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/uploadenvelopefile","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/uploadenvelopefile","metadata":{"seo":{"title":"Upload envelope file","description":"Adds a new file to the specified envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadEnvelopeFile","name":"Upload envelope file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload envelope file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new file to the specified envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_5","encoding":{"file":{"style":"form"},"documentClassId":{"style":"form"}}}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","href":"envelope-file/uploadenvelopefile","openApiOperationId":"uploadEnvelopeFile","summary":"Upload envelope file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_5","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/UploadEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/UploadEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadEnvelopeFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/uploadenvelopefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files"},{"label":"Reorder envelope files","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/reorderenvelopefiles","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/reorderenvelopefiles","metadata":{"seo":{"title":"Reorder envelope files","description":"Reorders the files of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderEnvelopeFiles","name":"Reorder envelope files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder envelope files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the files of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","href":"envelope-file/reorderenvelopefiles","openApiOperationId":"reorderEnvelopeFiles","summary":"Reorder envelope files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/reorderenvelopefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files"},{"label":"Get file properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/getenvelopefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/getenvelopefiledetail","metadata":{"seo":{"title":"Get file properties","description":"Returns the properties of a specific envelope file, including the assigned document class and its metadata values. Does not include the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelopeFileDetail","name":"Get file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the properties of a specific envelope file, including the assigned document class and its metadata values. Does not include the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","href":"envelope-file/getenvelopefiledetail","openApiOperationId":"getEnvelopeFileDetail","summary":"Get file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/getenvelopefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}"},{"label":"Update file properties","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/updateenvelopefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/updateenvelopefiledetail","metadata":{"seo":{"title":"Update file properties","description":"Updates the properties of a specific envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelopeFileDetail","name":"Update file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the properties of a specific envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","href":"envelope-file/updateenvelopefiledetail","openApiOperationId":"updateEnvelopeFileDetail","summary":"Update file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/updateenvelopefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}"},{"label":"Delete envelope file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file/deleteenvelopefile","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file/deleteenvelopefile","metadata":{"seo":{"title":"Delete envelope file","description":"Deletes a specific file from the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnvelopeFile","name":"Delete envelope file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete envelope file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific file from the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","href":"envelope-file/deleteenvelopefile","openApiOperationId":"deleteEnvelopeFile","summary":"Delete envelope file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file/deleteenvelopefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}"}],"content":{"contentType":"group","meta":{"name":"Envelope File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope File","showPageActions":true},{"nodeType":"markdoc","content":"Files of an envelope."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","summary":"List envelope files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-file/listenvelopefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","summary":"Upload envelope file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-file/uploadenvelopefile","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files","summary":"Reorder envelope files","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/envelope-file/reorderenvelopefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","summary":"Get file properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-file/getenvelopefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","summary":"Update file properties","prefix":{"name":"put","color":"put"},"badges":[],"link":"/envelope-file/updateenvelopefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}","summary":"Delete envelope file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/envelope-file/deleteenvelopefile","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope File Task","link":"/products/namirialsignenterprise/openapi3/envelope-file-task","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file-task","items":[{"label":"List file tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file-task/listenvelopefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file-task/listenvelopefiletasks","metadata":{"seo":{"title":"List file tasks","description":"Returns the tasks of a specific envelope file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeFileTasks","name":"List file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tasks of a specific envelope file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","href":"envelope-file-task/listenvelopefiletasks","openApiOperationId":"listEnvelopeFileTasks","summary":"List file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file-task/listenvelopefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks"},{"label":"Update file tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-file-task/updateenvelopefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-file-task/updateenvelopefiletasks","metadata":{"seo":{"title":"Update file tasks","description":"Replaces the tasks of a specific envelope file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelopeFileTasks","name":"Update file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the tasks of a specific envelope file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","href":"envelope-file-task/updateenvelopefiletasks","openApiOperationId":"updateEnvelopeFileTasks","summary":"Update file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-file-task/updateenvelopefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks"}],"content":{"contentType":"group","meta":{"name":"Envelope File Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope File Task","showPageActions":true},{"nodeType":"markdoc","content":"Tasks defined on a file of an envelope."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","summary":"List file tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-file-task/listenvelopefiletasks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks","summary":"Update file tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/envelope-file-task/updateenvelopefiletasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope Stage","link":"/products/namirialsignenterprise/openapi3/envelope-stage","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage","items":[{"label":"List envelope stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/listenvelopestages","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/listenvelopestages","metadata":{"seo":{"title":"List envelope stages","description":"Returns the stages of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeStages","name":"List envelope stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelope stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the stages of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","href":"envelope-stage/listenvelopestages","openApiOperationId":"listEnvelopeStages","summary":"List envelope stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/listenvelopestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages"},{"label":"Create envelope stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/createenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/createenvelopestage","metadata":{"seo":{"title":"Create envelope stage","description":"Creates a new stage for the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnvelopeStage","name":"Create envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new stage for the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","href":"envelope-stage/createenvelopestage","openApiOperationId":"createEnvelopeStage","summary":"Create envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/createenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages"},{"label":"Reorder envelope stages","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/reorderenvelopestages","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/reorderenvelopestages","metadata":{"seo":{"title":"Reorder envelope stages","description":"Reorders the stages of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderEnvelopeStages","name":"Reorder envelope stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder envelope stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the stages of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","href":"envelope-stage/reorderenvelopestages","openApiOperationId":"reorderEnvelopeStages","summary":"Reorder envelope stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/reorderenvelopestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages"},{"label":"Get envelope stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/getenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/getenvelopestage","metadata":{"seo":{"title":"Get envelope stage","description":"Returns a specific envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelopeStage","name":"Get envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","href":"envelope-stage/getenvelopestage","openApiOperationId":"getEnvelopeStage","summary":"Get envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/getenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}"},{"label":"Update envelope stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/updateenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/updateenvelopestage","metadata":{"seo":{"title":"Update envelope stage","description":"Updates a specific envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelopeStage","name":"Update envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","href":"envelope-stage/updateenvelopestage","openApiOperationId":"updateEnvelopeStage","summary":"Update envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/updateenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}"},{"label":"Delete envelope stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage/deleteenvelopestage","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage/deleteenvelopestage","metadata":{"seo":{"title":"Delete envelope stage","description":"Deletes a specific envelope stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnvelopeStage","name":"Delete envelope stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete envelope stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific envelope stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","href":"envelope-stage/deleteenvelopestage","openApiOperationId":"deleteEnvelopeStage","summary":"Delete envelope stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage/deleteenvelopestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}"}],"content":{"contentType":"group","meta":{"name":"Envelope Stage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope Stage","showPageActions":true},{"nodeType":"markdoc","content":"Stages of an envelope."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","summary":"List envelope stages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-stage/listenvelopestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","summary":"Create envelope stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-stage/createenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages","summary":"Reorder envelope stages","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/envelope-stage/reorderenvelopestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","summary":"Get envelope stage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-stage/getenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","summary":"Update envelope stage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/envelope-stage/updateenvelopestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}","summary":"Delete envelope stage","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/envelope-stage/deleteenvelopestage","deprecated":false}]}]}]}]}},{"type":"group","label":"Envelope Stage Recipient","link":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient","items":[{"label":"Create stage recipient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/createenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/createenvelopestagerecipient","metadata":{"seo":{"title":"Create stage recipient","description":"Creates a new recipient for the specified stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnvelopeStageRecipient","name":"Create stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new recipient for the specified stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients","href":"envelope-stage-recipient/createenvelopestagerecipient","openApiOperationId":"createEnvelopeStageRecipient","summary":"Create stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEnvelopeRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEnvelopeRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage-recipient/createenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients"},{"label":"Get stage recipient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/getenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/getenvelopestagerecipient","metadata":{"seo":{"title":"Get stage recipient","description":"Returns a specific stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelopeStageRecipient","name":"Get stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","href":"envelope-stage-recipient/getenvelopestagerecipient","openApiOperationId":"getEnvelopeStageRecipient","summary":"Get stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage-recipient/getenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Update stage recipient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/updateenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/updateenvelopestagerecipient","metadata":{"seo":{"title":"Update stage recipient","description":"Updates a specific stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelopeStageRecipient","name":"Update stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","href":"envelope-stage-recipient/updateenvelopestagerecipient","openApiOperationId":"updateEnvelopeStageRecipient","summary":"Update stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage-recipient/updateenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Delete stage recipient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/deleteenvelopestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/envelope-stage-recipient/deleteenvelopestagerecipient","metadata":{"seo":{"title":"Delete stage recipient","description":"Deletes a specific stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnvelopeStageRecipient","name":"Delete stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","href":"envelope-stage-recipient/deleteenvelopestagerecipient","openApiOperationId":"deleteEnvelopeStageRecipient","summary":"Delete stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/envelope-stage-recipient/deleteenvelopestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}"}],"content":{"contentType":"group","meta":{"name":"Envelope Stage Recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envelope Stage Recipient","showPageActions":true},{"nodeType":"markdoc","content":"Recipients of a stage of an envelope."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients","summary":"Create stage recipient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/envelope-stage-recipient/createenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Get stage recipient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/envelope-stage-recipient/getenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Update stage recipient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/envelope-stage-recipient/updateenvelopestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}","summary":"Delete stage recipient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/envelope-stage-recipient/deleteenvelopestagerecipient","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Settings Envelope","link":"/products/namirialsignenterprise/openapi3/organization-settings-envelope","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-envelope","items":[{"label":"Get agreement settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-envelope/getagreementsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-envelope/getagreementsettings","metadata":{"seo":{"title":"Get agreement settings","description":"Returns the envelope agreement configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgreementSettings","name":"Get agreement settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get agreement settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the envelope agreement configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","href":"organization-settings-envelope/getagreementsettings","openApiOperationId":"getAgreementSettings","summary":"Get agreement settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-envelope/getagreementsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/envelope/agreement"},{"label":"Update agreement settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-envelope/updateagreementsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-envelope/updateagreementsettings","metadata":{"seo":{"title":"Update agreement settings","description":"Replaces the envelope agreement configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAgreementSettings","name":"Update agreement settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update agreement settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the envelope agreement configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","href":"organization-settings-envelope/updateagreementsettings","openApiOperationId":"updateAgreementSettings","summary":"Update agreement settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgreementSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-envelope/updateagreementsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/envelope/agreement"}],"content":{"contentType":"group","meta":{"name":"Organization Settings Envelope"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Settings Envelope","showPageActions":true},{"nodeType":"markdoc","content":"Organization-level envelope agreement settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","summary":"Get agreement settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-envelope/getagreementsettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/envelope/agreement","summary":"Update agreement settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-envelope/updateagreementsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Settings General","link":"/products/namirialsignenterprise/openapi3/organization-settings-general","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general","items":[{"label":"Get general settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/getgeneralsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/getgeneralsettings","metadata":{"seo":{"title":"Get general settings","description":"Returns the general configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeneralSettings","name":"Get general settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get general settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the general configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/general","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general","href":"organization-settings-general/getgeneralsettings","openApiOperationId":"getGeneralSettings","summary":"Get general settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeneralSettings"}},"schemaId":"components/schemas/GeneralSettings"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GeneralSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeneralSettings"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/getgeneralsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general"},{"label":"Update general settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/updategeneralsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/updategeneralsettings","metadata":{"seo":{"title":"Update general settings","description":"Updates the general configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGeneralSettings","name":"Update general settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update general settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the general configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateGeneralSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateGeneralSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/settings/general","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateGeneralSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general","href":"organization-settings-general/updategeneralsettings","openApiOperationId":"updateGeneralSettings","summary":"Update general settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateGeneralSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateGeneralSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/updategeneralsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general"},{"label":"Get language settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/getlanguagesettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/getlanguagesettings","metadata":{"seo":{"title":"Get language settings","description":"Returns the languages enabled for the specified organization, in alphabetical order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLanguageSettings","name":"Get language settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get language settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the languages enabled for the specified organization, in alphabetical order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/general/languages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general/languages","href":"organization-settings-general/getlanguagesettings","openApiOperationId":"getLanguageSettings","summary":"Get language settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LanguageSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/LanguageSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LanguageSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LanguageSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/getlanguagesettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general/languages"},{"label":"Update language settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/updatelanguagesettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/updatelanguagesettings","metadata":{"seo":{"title":"Update language settings","description":"Replaces the languages enabled for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLanguageSettings","name":"Update language settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update language settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the languages enabled for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateLanguageSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateLanguageSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/general/languages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateLanguageSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general/languages","href":"organization-settings-general/updatelanguagesettings","openApiOperationId":"updateLanguageSettings","summary":"Update language settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateLanguageSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateLanguageSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/updatelanguagesettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general/languages"},{"label":"Get regional defaults settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/getregionaldefaultssettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/getregionaldefaultssettings","metadata":{"seo":{"title":"Get regional defaults settings","description":"Returns the default language, time zone and date-time format for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRegionalDefaultsSettings","name":"Get regional defaults settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get regional defaults settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default language, time zone and date-time format for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/general/regional","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general/regional","href":"organization-settings-general/getregionaldefaultssettings","openApiOperationId":"getRegionalDefaultsSettings","summary":"Get regional defaults settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionalDefaultsSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/RegionalDefaultsSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionalDefaultsSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionalDefaultsSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/getregionaldefaultssettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general/regional"},{"label":"Update regional defaults settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-general/updateregionaldefaultssettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-general/updateregionaldefaultssettings","metadata":{"seo":{"title":"Update regional defaults settings","description":"Replaces the default language, time zone and date-time format for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRegionalDefaultsSettings","name":"Update regional defaults settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update regional defaults settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the default language, time zone and date-time format for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRegionalDefaultsSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateRegionalDefaultsSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/general/regional","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRegionalDefaultsSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/general/regional","href":"organization-settings-general/updateregionaldefaultssettings","openApiOperationId":"updateRegionalDefaultsSettings","summary":"Update regional defaults settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateRegionalDefaultsSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRegionalDefaultsSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-general/updateregionaldefaultssettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/general/regional"}],"content":{"contentType":"group","meta":{"name":"Organization Settings General"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Settings General","showPageActions":true},{"nodeType":"markdoc","content":"Organization-level general, language and regional settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/settings/general","summary":"Get general settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-general/getgeneralsettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/general","summary":"Update general settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-settings-general/updategeneralsettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/general/languages","summary":"Get language settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-general/getlanguagesettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/general/languages","summary":"Update language settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-general/updatelanguagesettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/general/regional","summary":"Get regional defaults settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-general/getregionaldefaultssettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/general/regional","summary":"Update regional defaults settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-general/updateregionaldefaultssettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Settings Recipient","link":"/products/namirialsignenterprise/openapi3/organization-settings-recipient","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-recipient","items":[{"label":"Get recipient settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/getrecipientsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/getrecipientsettings","metadata":{"seo":{"title":"Get recipient settings","description":"Returns the recipient configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRecipientSettings","name":"Get recipient settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get recipient settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the recipient configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/recipient","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/recipient","href":"organization-settings-recipient/getrecipientsettings","openApiOperationId":"getRecipientSettings","summary":"Get recipient settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecipientSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth"]}},"schemaId":"components/schemas/RecipientSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecipientSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecipientSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-recipient/getrecipientsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/recipient"},{"label":"Update recipient settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/updaterecipientsettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/updaterecipientsettings","metadata":{"seo":{"title":"Update recipient settings","description":"Updates the recipient configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRecipientSettings","name":"Update recipient settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update recipient settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the recipient configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRecipientSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"]}},"schemaId":"components/schemas/UpdateRecipientSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/settings/recipient","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRecipientSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/recipient","href":"organization-settings-recipient/updaterecipientsettings","openApiOperationId":"updateRecipientSettings","summary":"Update recipient settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateRecipientSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRecipientSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-recipient/updaterecipientsettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/recipient"},{"label":"List OAuth providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/listoauthproviders","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-recipient/listoauthproviders","metadata":{"seo":{"title":"List OAuth providers","description":"Returns a paginated list of OAuth providers configured for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOAuthProviders","name":"List OAuth providers","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient~1oauth-providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List OAuth providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of OAuth providers configured for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient~1oauth-providers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient~1oauth-providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/recipient/oauth-providers","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/recipient/oauth-providers","href":"organization-settings-recipient/listoauthproviders","openApiOperationId":"listOAuthProviders","summary":"List OAuth providers","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthProviderListResponse"}},"schemaId":"components/schemas/OAuthProviderListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient~1oauth-providers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OAuthProviderListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthProviderListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-recipient/listoauthproviders"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/recipient/oauth-providers"}],"content":{"contentType":"group","meta":{"name":"Organization Settings Recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Settings Recipient","showPageActions":true},{"nodeType":"markdoc","content":"Organization-level recipient settings and OAuth providers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/settings/recipient","summary":"Get recipient settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-recipient/getrecipientsettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/recipient","summary":"Update recipient settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-settings-recipient/updaterecipientsettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/recipient/oauth-providers","summary":"List OAuth providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-recipient/listoauthproviders","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Settings Signature","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature","items":[{"label":"Get signature settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturesettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturesettings","metadata":{"seo":{"title":"Get signature settings","description":"Returns the signature configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSignatureSettings","name":"Get signature settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get signature settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the signature configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/signature","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature","href":"organization-settings-signature/getsignaturesettings","openApiOperationId":"getSignatureSettings","summary":"Get signature settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SignatureSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignatureSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureSettings","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/getsignaturesettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature"},{"label":"Update signature settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturesettings","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturesettings","metadata":{"seo":{"title":"Update signature settings","description":"Updates the signature configuration for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSignatureSettings","name":"Update signature settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update signature settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the signature configuration for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSignatureSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateSignatureSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/settings/signature","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSignatureSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature","href":"organization-settings-signature/updatesignaturesettings","openApiOperationId":"updateSignatureSettings","summary":"Update signature settings","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateSignatureSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSignatureSettingsRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/updatesignaturesettings"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature"},{"label":"List signature layouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/listsignaturelayouts","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/listsignaturelayouts","metadata":{"seo":{"title":"List signature layouts","description":"Returns the identifier and name of the signature layouts of the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSignatureLayouts","name":"List signature layouts","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List signature layouts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the identifier and name of the signature layouts of the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/signature/layouts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature/layouts","href":"organization-settings-signature/listsignaturelayouts","openApiOperationId":"listSignatureLayouts","summary":"List signature layouts","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureLayoutListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SignatureLayoutListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignatureLayoutListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureLayoutListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/listsignaturelayouts"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature/layouts"},{"label":"Create a signature layout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/createsignaturelayout","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/createsignaturelayout","metadata":{"seo":{"title":"Create a signature layout","description":"Creates a signature layout for the specified organization and returns its identifier. The name is a slug of 1-50 characters (letters, digits and hyphens, not starting or ending with a hyphen), unique within the organization; default is reserved. When the dateTime row is visible, format must be one of the code values returned by GET /api/v1/datetime-formats and localTimezone is required: when it is false, timezone must be exactly one of the code values returned by GET /api/v1/timezones; when it is true, timezone must be omitted. The optional image accepts the MIME types image/png, image/jpeg, image/gif and image/webp, up to 716800 base64 characters (about 512 KB). Validation errors are returned as 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSignatureLayout","name":"Create a signature layout","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a signature layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a signature layout for the specified organization and returns its identifier. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a slug of 1-50 characters (letters, digits and hyphens, not starting or ending with a hyphen), unique within the organization; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reserved. When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" row is visible, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values returned by GET /api/v1/datetime-formats and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localTimezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required: when it is false, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be exactly one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values returned by GET /api/v1/timezones; when it is true, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be omitted. The optional image accepts the MIME types image/png, image/jpeg, image/gif and image/webp, up to 716800 base64 characters (about 512 KB). Validation errors are returned as 422."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/settings/signature/layouts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature/layouts","href":"organization-settings-signature/createsignaturelayout","openApiOperationId":"createSignatureLayout","summary":"Create a signature layout","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSignatureLayoutResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateSignatureLayoutResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateSignatureLayoutResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSignatureLayoutResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/createsignaturelayout"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature/layouts"},{"label":"Get a signature layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturelayout","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturelayout","metadata":{"seo":{"title":"Get a signature layout","description":"Returns the full configuration of a signature layout of the specified organization: the fields shown in the signature appearance and the optional image. In the response, localTimezone is always set and timezone is null when localTimezone is true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSignatureLayout","name":"Get a signature layout","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a signature layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full configuration of a signature layout of the specified organization: the fields shown in the signature appearance and the optional image. In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localTimezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localTimezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"layoutId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"layoutId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","href":"organization-settings-signature/getsignaturelayout","openApiOperationId":"getSignatureLayout","summary":"Get a signature layout","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureLayout","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SignatureLayout","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignatureLayout","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureLayout","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/getsignaturelayout"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}"},{"label":"Replace a signature layout","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturelayout","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturelayout","metadata":{"seo":{"title":"Replace a signature layout","description":"Replaces the whole signature layout, image included: omitting image removes it. The same rules of the creation apply. The layout named default cannot be renamed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSignatureLayout","name":"Replace a signature layout","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a signature layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the whole signature layout, image included: omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" removes it. The same rules of the creation apply. The layout named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be renamed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"layoutId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"layoutId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","href":"organization-settings-signature/updatesignaturelayout","openApiOperationId":"updateSignatureLayout","summary":"Replace a signature layout","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignatureLayoutRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/updatesignaturelayout"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}"},{"label":"Delete a signature layout","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-signature/deletesignaturelayout","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-signature/deletesignaturelayout","metadata":{"seo":{"title":"Delete a signature layout","description":"Deletes a signature layout of the specified organization. The layout named default cannot be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSignatureLayout","name":"Delete a signature layout","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a signature layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a signature layout of the specified organization. The layout named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"layoutId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"layoutId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","href":"organization-settings-signature/deletesignaturelayout","openApiOperationId":"deleteSignatureLayout","summary":"Delete a signature layout","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-signature/deletesignaturelayout"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}"}],"content":{"contentType":"group","meta":{"name":"Organization Settings Signature"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Settings Signature","showPageActions":true},{"nodeType":"markdoc","content":"Organization-level signature settings and signature layouts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/settings/signature","summary":"Get signature settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-signature/getsignaturesettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature","summary":"Update signature settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-settings-signature/updatesignaturesettings","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature/layouts","summary":"List signature layouts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-signature/listsignaturelayouts","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature/layouts","summary":"Create a signature layout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-settings-signature/createsignaturelayout","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","summary":"Get a signature layout","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-signature/getsignaturelayout","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","summary":"Replace a signature layout","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-signature/updatesignaturelayout","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}","summary":"Delete a signature layout","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-settings-signature/deletesignaturelayout","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Settings User","link":"/products/namirialsignenterprise/openapi3/organization-settings-user","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user","items":[{"label":"List business roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/listbusinessroles","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/listbusinessroles","metadata":{"seo":{"title":"List business roles","description":"Returns a paginated list of business roles for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBusinessRoles","name":"List business roles","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List business roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of business roles for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SortingKey","in":"query","schemaId":"schema_21","description":"Optional sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Whether to sort in ascending order."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/user/business-roles","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/BusinessRolesSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/business-roles","href":"organization-settings-user/listbusinessroles","openApiOperationId":"listBusinessRoles","summary":"List business roles","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessRoleListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BusinessRoleListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessRoleListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessRoleListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/listbusinessroles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/business-roles"},{"label":"Create business role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/createbusinessrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/createbusinessrole","metadata":{"seo":{"title":"Create business role","description":"Creates a new business role with the specified name and optional description."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBusinessRole","name":"Create business role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create business role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new business role with the specified name and optional description."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/settings/user/business-roles","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/business-roles","href":"organization-settings-user/createbusinessrole","openApiOperationId":"createBusinessRole","summary":"Create business role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBusinessRoleResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBusinessRoleResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateBusinessRoleResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateBusinessRoleResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/createbusinessrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/business-roles"},{"label":"Get business role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/getbusinessrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/getbusinessrole","metadata":{"seo":{"title":"Get business role","description":"Returns the details of the specified business role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusinessRole","name":"Get business role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get business role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the details of the specified business role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"businessRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the business role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"businessRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","href":"organization-settings-user/getbusinessrole","openApiOperationId":"getBusinessRole","summary":"Get business role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessRoleDetails"}},"schemaId":"components/schemas/BusinessRoleDetails"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessRoleDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessRoleDetails"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/getbusinessrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}"},{"label":"Update business role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/updatebusinessrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/updatebusinessrole","metadata":{"seo":{"title":"Update business role","description":"Replaces the name and description of the specified business role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBusinessRole","name":"Update business role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update business role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the name and description of the specified business role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"businessRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the business role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"businessRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","href":"organization-settings-user/updatebusinessrole","openApiOperationId":"updateBusinessRole","summary":"Update business role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBusinessRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/updatebusinessrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}"},{"label":"Delete business role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/deletebusinessrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/deletebusinessrole","metadata":{"seo":{"title":"Delete business role","description":"Deletes the specified business role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBusinessRole","name":"Delete business role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete business role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified business role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"businessRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the business role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"businessRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","href":"organization-settings-user/deletebusinessrole","openApiOperationId":"deleteBusinessRole","summary":"Delete business role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/deletebusinessrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}"},{"label":"List application roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/listapplicationroles","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/listapplicationroles","metadata":{"seo":{"title":"List application roles","description":"Returns a paginated list of application roles for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationRoles","name":"List application roles","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List application roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of application roles for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SortingKey","in":"query","schemaId":"schema_22","description":"Optional sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Optional sort direction."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/user/application-roles","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/ApplicationRoleSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/application-roles","href":"organization-settings-user/listapplicationroles","openApiOperationId":"listApplicationRoles","summary":"List application roles","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationRoleListResponse"}},"schemaId":"components/schemas/ApplicationRoleListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationRoleListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationRoleListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/listapplicationroles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/application-roles"},{"label":"Create application role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/createapplicationrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/createapplicationrole","metadata":{"seo":{"title":"Create application role","description":"Creates a new custom application role with the specified name, optional description, and permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationRole","name":"Create application role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create application role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new custom application role with the specified name, optional description, and permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/settings/user/application-roles","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/application-roles","href":"organization-settings-user/createapplicationrole","openApiOperationId":"createApplicationRole","summary":"Create application role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApplicationRoleResponse"}},"schemaId":"components/schemas/CreateApplicationRoleResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateApplicationRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApplicationRoleResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/createapplicationrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/application-roles"},{"label":"Get application role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/getapplicationrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/getapplicationrole","metadata":{"seo":{"title":"Get application role","description":"Returns the full details of the specified application role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationRole","name":"Get application role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get application role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full details of the specified application role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"applicationRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the application role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"applicationRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","href":"organization-settings-user/getapplicationrole","openApiOperationId":"getApplicationRole","summary":"Get application role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationRoleResponse"}},"schemaId":"components/schemas/ApplicationRoleResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationRoleResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/getapplicationrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}"},{"label":"Update application role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/updateapplicationrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/updateapplicationrole","metadata":{"seo":{"title":"Update application role","description":"Replaces the name, description, and permissions of the specified application role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationRole","name":"Update application role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update application role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the name, description, and permissions of the specified application role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"applicationRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the application role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"applicationRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","href":"organization-settings-user/updateapplicationrole","openApiOperationId":"updateApplicationRole","summary":"Update application role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateApplicationRoleRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/updateapplicationrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}"},{"label":"Delete application role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/organization-settings-user/deleteapplicationrole","routeSlug":"/products/namirialsignenterprise/openapi3/organization-settings-user/deleteapplicationrole","metadata":{"seo":{"title":"Delete application role","description":"Deletes the specified custom application role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationRole","name":"Delete application role","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete application role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified custom application role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"applicationRoleId","in":"path","schemaId":"schema_0","description":"Unique identifier of the application role","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"applicationRoleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","href":"organization-settings-user/deleteapplicationrole","openApiOperationId":"deleteApplicationRole","summary":"Delete application role","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-settings-user/deleteapplicationrole"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}"}],"content":{"contentType":"group","meta":{"name":"Organization Settings User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Settings User","showPageActions":true},{"nodeType":"markdoc","content":"Organization-level business roles and application roles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/settings/user/business-roles","summary":"List business roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-user/listbusinessroles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/business-roles","summary":"Create business role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-settings-user/createbusinessrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","summary":"Get business role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-user/getbusinessrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","summary":"Update business role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-user/updatebusinessrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}","summary":"Delete business role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-settings-user/deletebusinessrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/application-roles","summary":"List application roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-user/listapplicationroles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/application-roles","summary":"Create application role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-settings-user/createapplicationrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","summary":"Get application role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-settings-user/getapplicationrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","summary":"Update application role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-settings-user/updateapplicationrole","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}","summary":"Delete application role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-settings-user/deleteapplicationrole","deprecated":false}]}]}]}]}},{"type":"group","label":"Policy","link":"/products/namirialsignenterprise/openapi3/policy","routeSlug":"/products/namirialsignenterprise/openapi3/policy","items":[{"label":"List policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/policy/listpolicies","routeSlug":"/products/namirialsignenterprise/openapi3/policy/listpolicies","metadata":{"seo":{"title":"List policies","description":"Returns a paginated list of policies for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPolicies","name":"List policies","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of policies for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SearchText","in":"query","schemaId":"schema_23","description":"Optional free-text filter."},{"name":"DocumentClassId","in":"query","schemaId":"schema_0","description":"Optional document class filter."},{"name":"SortingKey","in":"query","schemaId":"schema_24","description":"Optional sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Optional sort direction."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/policies","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SearchText","in":"query","schemaId":"schema_23"},{"name":"DocumentClassId","in":"query","schemaId":"schema_0"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/PolicySortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/policies","href":"policy/listpolicies","openApiOperationId":"listPolicies","summary":"List policies","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PolicyListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PolicyListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy/listpolicies"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/policies"},{"label":"Create policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/policy/createpolicy","routeSlug":"/products/namirialsignenterprise/openapi3/policy/createpolicy","metadata":{"seo":{"title":"Create policy","description":"Creates a new policy with the specified conditions and actions for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPolicy","name":"Create policy","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new policy with the specified conditions and actions for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"schemaId":"components/schemas/CreatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/policies","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/policies","href":"policy/createpolicy","openApiOperationId":"createPolicy","summary":"Create policy","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedPolicyResponse"}},"schemaId":"components/schemas/CreatedPolicyResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreatedPolicyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedPolicyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy/createpolicy"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/policies"},{"label":"Get policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/policy/getpolicy","routeSlug":"/products/namirialsignenterprise/openapi3/policy/getpolicy","metadata":{"seo":{"title":"Get policy","description":"Returns the full policy, including its conditions and actions, for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPolicy","name":"Get policy","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full policy, including its conditions and actions, for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"policyId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/policies/{policyId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/policies/{policyId}","href":"policy/getpolicy","openApiOperationId":"getPolicy","summary":"Get policy","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PolicyResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PolicyResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy/getpolicy"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/policies/{policyId}"},{"label":"Update policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/policy/updatepolicy","routeSlug":"/products/namirialsignenterprise/openapi3/policy/updatepolicy","metadata":{"seo":{"title":"Update policy","description":"Updates a specific policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePolicy","name":"Update policy","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific policy."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"policyId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"schemaId":"components/schemas/UpdatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/policies/{policyId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/policies/{policyId}","href":"policy/updatepolicy","openApiOperationId":"updatePolicy","summary":"Update policy","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePolicyRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic","paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy/updatepolicy"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/policies/{policyId}"},{"label":"Delete policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/policy/deletepolicy","routeSlug":"/products/namirialsignenterprise/openapi3/policy/deletepolicy","metadata":{"seo":{"title":"Delete policy","description":"Deletes the specified policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePolicy","name":"Delete policy","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified policy."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"policyId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/policies/{policyId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/policies/{policyId}","href":"policy/deletepolicy","openApiOperationId":"deletePolicy","summary":"Delete policy","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policy/deletepolicy"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/policies/{policyId}"}],"content":{"contentType":"group","meta":{"name":"Policy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Policy","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/policies","summary":"List policies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policy/listpolicies","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/policies","summary":"Create policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/policy/createpolicy","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/policies/{policyId}","summary":"Get policy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policy/getpolicy","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/policies/{policyId}","summary":"Update policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/policy/updatepolicy","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/policies/{policyId}","summary":"Delete policy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/policy/deletepolicy","deprecated":false}]}]}]}]}},{"type":"group","label":"Template","link":"/products/namirialsignenterprise/openapi3/template","routeSlug":"/products/namirialsignenterprise/openapi3/template","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template/listtemplates","routeSlug":"/products/namirialsignenterprise/openapi3/template/listtemplates","metadata":{"seo":{"title":"List templates","description":"Returns a paginated list of templates for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplates","name":"List templates","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of templates for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1","description":"Filter templates updated before this date."},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1","description":"Filter templates updated after this date."},{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"UpdatedBefore","in":"query","schemaId":"schema_1"},{"name":"UpdatedAfter","in":"query","schemaId":"schema_1"},{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates","href":"template/listtemplates","openApiOperationId":"listTemplates","summary":"List templates","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TemplateListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/listtemplates"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates"},{"label":"Create template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template/createtemplate","routeSlug":"/products/namirialsignenterprise/openapi3/template/createtemplate","metadata":{"seo":{"title":"Create template","description":"Creates a new template within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTemplate","name":"Create template","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new template within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/CreateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/templates","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates","href":"template/createtemplate","openApiOperationId":"createTemplate","summary":"Create template","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/createtemplate"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates"},{"label":"Get template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template/gettemplate","routeSlug":"/products/namirialsignenterprise/openapi3/template/gettemplate","metadata":{"seo":{"title":"Get template","description":"Returns a specific template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplate","name":"Get template","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}","href":"template/gettemplate","openApiOperationId":"getTemplate","summary":"Get template","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/gettemplate"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}"},{"label":"Update template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template/updatetemplate","routeSlug":"/products/namirialsignenterprise/openapi3/template/updatetemplate","metadata":{"seo":{"title":"Update template","description":"Updates a specific template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplate","name":"Update template","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"]}},"schemaId":"components/schemas/UpdateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/templates/{templateId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}","href":"template/updatetemplate","openApiOperationId":"updateTemplate","summary":"Update template","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTemplateRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/updatetemplate"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}"},{"label":"Delete template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template/deletetemplate","routeSlug":"/products/namirialsignenterprise/openapi3/template/deletetemplate","metadata":{"seo":{"title":"Delete template","description":"Deletes a specific template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplate","name":"Delete template","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/templates/{templateId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}","href":"template/deletetemplate","openApiOperationId":"deleteTemplate","summary":"Delete template","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/deletetemplate"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}"}],"content":{"contentType":"group","meta":{"name":"Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template","showPageActions":true},{"nodeType":"markdoc","content":"Operations for managing templates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates","summary":"List templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template/listtemplates","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates","summary":"Create template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template/createtemplate","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}","summary":"Get template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template/gettemplate","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}","summary":"Update template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template/updatetemplate","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}","summary":"Delete template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/template/deletetemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Template Action","link":"/products/namirialsignenterprise/openapi3/template-action","routeSlug":"/products/namirialsignenterprise/openapi3/template-action","items":[{"label":"Create envelope from template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-action/createenvelopefromtemplate","routeSlug":"/products/namirialsignenterprise/openapi3/template-action/createenvelopefromtemplate","metadata":{"seo":{"title":"Create envelope from template","description":"Creates a new draft envelope from the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnvelopeFromTemplate","name":"Create envelope from template","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create envelope from template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new draft envelope from the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/create-envelope","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/create-envelope","href":"template-action/createenvelopefromtemplate","openApiOperationId":"createEnvelopeFromTemplate","summary":"Create envelope from template","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeFromTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEnvelopeFromTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEnvelopeFromTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeFromTemplateResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-action/createenvelopefromtemplate"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/create-envelope"}],"content":{"contentType":"group","meta":{"name":"Template Action"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template Action","showPageActions":true},{"nodeType":"markdoc","content":"Actions to create envelopes from templates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/create-envelope","summary":"Create envelope from template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template-action/createenvelopefromtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Template File","link":"/products/namirialsignenterprise/openapi3/template-file","routeSlug":"/products/namirialsignenterprise/openapi3/template-file","items":[{"label":"List template files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/listtemplatefiles","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/listtemplatefiles","metadata":{"seo":{"title":"List template files","description":"Returns the files of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplateFiles","name":"List template files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List template files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the files of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","href":"template-file/listtemplatefiles","openApiOperationId":"listTemplateFiles","summary":"List template files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TemplateFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateFileListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/listtemplatefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files"},{"label":"Upload template file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/uploadtemplatefile","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/uploadtemplatefile","metadata":{"seo":{"title":"Upload template file","description":"Adds a new file to the specified template. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadTemplateFile","name":"Upload template file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload template file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new file to the specified template. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document class must be set afterwards via Update file properties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_5","encoding":{"file":{"style":"form"},"documentClassId":{"style":"form"}}}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","href":"template-file/uploadtemplatefile","openApiOperationId":"uploadTemplateFile","summary":"Upload template file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_5","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadTemplateFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/UploadTemplateFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/UploadTemplateFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadTemplateFileResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/uploadtemplatefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files"},{"label":"Reorder template files","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/reordertemplatefiles","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/reordertemplatefiles","metadata":{"seo":{"title":"Reorder template files","description":"Reorders the files of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderTemplateFiles","name":"Reorder template files","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder template files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the files of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","href":"template-file/reordertemplatefiles","openApiOperationId":"reorderTemplateFiles","summary":"Reorder template files","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEnvelopeFilesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/reordertemplatefiles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files"},{"label":"Get file properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/gettemplatefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/gettemplatefiledetail","metadata":{"seo":{"title":"Get file properties","description":"Returns the properties of a specific template file, including the assigned document class and its metadata values. Does not include the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateFileDetail","name":"Get file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the properties of a specific template file, including the assigned document class and its metadata values. Does not include the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","href":"template-file/gettemplatefiledetail","openApiOperationId":"getTemplateFileDetail","summary":"Get file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TemplateFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateFileDetailResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/gettemplatefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}"},{"label":"Update file properties","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/updatetemplatefiledetail","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/updatetemplatefiledetail","metadata":{"seo":{"title":"Update file properties","description":"Updates the properties of a specific template file. Currently supports assigning a document class with metadata values. Does not modify the file content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplateFileDetail","name":"Update file properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update file properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the properties of a specific template file. Currently supports assigning a document class with metadata values. Does not modify the file content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTemplateFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTemplateFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTemplateFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","href":"template-file/updatetemplatefiledetail","openApiOperationId":"updateTemplateFileDetail","summary":"Update file properties","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateTemplateFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTemplateFileDetailRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/updatetemplatefiledetail"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}"},{"label":"Delete template file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file/deletetemplatefile","routeSlug":"/products/namirialsignenterprise/openapi3/template-file/deletetemplatefile","metadata":{"seo":{"title":"Delete template file","description":"Deletes a specific file from the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplateFile","name":"Delete template file","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific file from the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","href":"template-file/deletetemplatefile","openApiOperationId":"deleteTemplateFile","summary":"Delete template file","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file/deletetemplatefile"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}"}],"content":{"contentType":"group","meta":{"name":"Template File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template File","showPageActions":true},{"nodeType":"markdoc","content":"Files of a template."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","summary":"List template files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-file/listtemplatefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","summary":"Upload template file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template-file/uploadtemplatefile","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files","summary":"Reorder template files","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/template-file/reordertemplatefiles","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","summary":"Get file properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-file/gettemplatefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","summary":"Update file properties","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template-file/updatetemplatefiledetail","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}","summary":"Delete template file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/template-file/deletetemplatefile","deprecated":false}]}]}]}]}},{"type":"group","label":"Template File Task","link":"/products/namirialsignenterprise/openapi3/template-file-task","routeSlug":"/products/namirialsignenterprise/openapi3/template-file-task","items":[{"label":"List file tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file-task/listtemplatefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/template-file-task/listtemplatefiletasks","metadata":{"seo":{"title":"List file tasks","description":"Returns the tasks of a specific template file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplateFileTasks","name":"List file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tasks of a specific template file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","href":"template-file-task/listtemplatefiletasks","openApiOperationId":"listTemplateFileTasks","summary":"List file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldTaskListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file-task/listtemplatefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks"},{"label":"Update file tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-file-task/updatetemplatefiletasks","routeSlug":"/products/namirialsignenterprise/openapi3/template-file-task/updatetemplatefiletasks","metadata":{"seo":{"title":"Update file tasks","description":"Replaces the tasks of a specific template file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplateFileTasks","name":"Update file tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update file tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the tasks of a specific template file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"fileId","in":"path","schemaId":"schema_0","description":"Unique identifier of the file","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","href":"template-file-task/updatetemplatefiletasks","openApiOperationId":"updateTemplateFileTasks","summary":"Update file tasks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeFileTasksRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-file-task/updatetemplatefiletasks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks"}],"content":{"contentType":"group","meta":{"name":"Template File Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template File Task","showPageActions":true},{"nodeType":"markdoc","content":"Tasks defined on a file of a template."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","summary":"List file tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-file-task/listtemplatefiletasks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks","summary":"Update file tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template-file-task/updatetemplatefiletasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Template Stage","link":"/products/namirialsignenterprise/openapi3/template-stage","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage","items":[{"label":"List template stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/listtemplatestages","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/listtemplatestages","metadata":{"seo":{"title":"List template stages","description":"Returns the stages of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplateStages","name":"List template stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List template stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the stages of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","href":"template-stage/listtemplatestages","openApiOperationId":"listTemplateStages","summary":"List template stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TemplateStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateStageListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/listtemplatestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages"},{"label":"Create template stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/createtemplatestage","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/createtemplatestage","metadata":{"seo":{"title":"Create template stage","description":"Creates a new stage for the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTemplateStage","name":"Create template stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create template stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new stage for the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","href":"template-stage/createtemplatestage","openApiOperationId":"createTemplateStage","summary":"Create template stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateTemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/createtemplatestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages"},{"label":"Reorder template stages","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/reordertemplatestages","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/reordertemplatestages","metadata":{"seo":{"title":"Reorder template stages","description":"Reorders the stages of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderTemplateStages","name":"Reorder template stages","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder template stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reorders the stages of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchTemplateStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchTemplateStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchTemplateStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","href":"template-stage/reordertemplatestages","openApiOperationId":"reorderTemplateStages","summary":"Reorder template stages","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/PatchTemplateStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchTemplateStagesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/reordertemplatestages"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages"},{"label":"Get template stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/gettemplatestage","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/gettemplatestage","metadata":{"seo":{"title":"Get template stage","description":"Returns a specific template stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateStage","name":"Get template stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific template stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","href":"template-stage/gettemplatestage","openApiOperationId":"getTemplateStage","summary":"Get template stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateStageResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/gettemplatestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}"},{"label":"Update template stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/updatetemplatestage","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/updatetemplatestage","metadata":{"seo":{"title":"Update template stage","description":"Updates a specific template stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplateStage","name":"Update template stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific template stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","href":"template-stage/updatetemplatestage","openApiOperationId":"updateTemplateStage","summary":"Update template stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeStageRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/updatetemplatestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}"},{"label":"Delete template stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage/deletetemplatestage","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage/deletetemplatestage","metadata":{"seo":{"title":"Delete template stage","description":"Deletes a specific template stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplateStage","name":"Delete template stage","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific template stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","href":"template-stage/deletetemplatestage","openApiOperationId":"deleteTemplateStage","summary":"Delete template stage","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage/deletetemplatestage"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}"}],"content":{"contentType":"group","meta":{"name":"Template Stage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template Stage","showPageActions":true},{"nodeType":"markdoc","content":"Stages of a template."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","summary":"List template stages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-stage/listtemplatestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","summary":"Create template stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template-stage/createtemplatestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages","summary":"Reorder template stages","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/template-stage/reordertemplatestages","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","summary":"Get template stage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-stage/gettemplatestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","summary":"Update template stage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template-stage/updatetemplatestage","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}","summary":"Delete template stage","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/template-stage/deletetemplatestage","deprecated":false}]}]}]}]}},{"type":"group","label":"Template Stage Recipient","link":"/products/namirialsignenterprise/openapi3/template-stage-recipient","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage-recipient","items":[{"label":"Create template stage recipient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage-recipient/createtemplatestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage-recipient/createtemplatestagerecipient","metadata":{"seo":{"title":"Create template stage recipient","description":"Creates a new recipient for the specified template stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTemplateStageRecipient","name":"Create template stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create template stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new recipient for the specified template stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients","href":"template-stage-recipient/createtemplatestagerecipient","openApiOperationId":"createTemplateStageRecipient","summary":"Create template stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTemplateRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateTemplateRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTemplateRecipientResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage-recipient/createtemplatestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients"},{"label":"Get template stage recipient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage-recipient/gettemplatestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage-recipient/gettemplatestagerecipient","metadata":{"seo":{"title":"Get template stage recipient","description":"Returns a specific template stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateStageRecipient","name":"Get template stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific template stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","href":"template-stage-recipient/gettemplatestagerecipient","openApiOperationId":"getTemplateStageRecipient","summary":"Get template stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage-recipient/gettemplatestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Update template stage recipient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage-recipient/updatetemplatestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage-recipient/updatetemplatestagerecipient","metadata":{"seo":{"title":"Update template stage recipient","description":"Updates a specific template stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplateStageRecipient","name":"Update template stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific template stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","href":"template-stage-recipient/updatetemplatestagerecipient","openApiOperationId":"updateTemplateStageRecipient","summary":"Update template stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth","paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage-recipient/updatetemplatestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}"},{"label":"Delete template stage recipient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/template-stage-recipient/deletetemplatestagerecipient","routeSlug":"/products/namirialsignenterprise/openapi3/template-stage-recipient/deletetemplatestagerecipient","metadata":{"seo":{"title":"Delete template stage recipient","description":"Deletes a specific template stage recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplateStageRecipient","name":"Delete template stage recipient","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template stage recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific template stage recipient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"templateId","in":"path","schemaId":"schema_0","description":"Unique identifier of the template","required":true},{"name":"stageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the stage","required":true},{"name":"recipientId","in":"path","schemaId":"schema_0","description":"Unique identifier of the recipient","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_0"},{"name":"stageId","in":"path","required":true,"schemaId":"schema_0"},{"name":"recipientId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","href":"template-stage-recipient/deletetemplatestagerecipient","openApiOperationId":"deleteTemplateStageRecipient","summary":"Delete template stage recipient","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template-stage-recipient/deletetemplatestagerecipient"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}"}],"content":{"contentType":"group","meta":{"name":"Template Stage Recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template Stage Recipient","showPageActions":true},{"nodeType":"markdoc","content":"Recipients of a stage of a template."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients","summary":"Create template stage recipient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template-stage-recipient/createtemplatestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","summary":"Get template stage recipient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template-stage-recipient/gettemplatestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","summary":"Update template stage recipient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template-stage-recipient/updatetemplatestagerecipient","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}","summary":"Delete template stage recipient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/template-stage-recipient/deletetemplatestagerecipient","deprecated":false}]}]}]}]}},{"type":"group","label":"User","link":"/products/namirialsignenterprise/openapi3/user","routeSlug":"/products/namirialsignenterprise/openapi3/user","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/listusers","routeSlug":"/products/namirialsignenterprise/openapi3/user/listusers","metadata":{"seo":{"title":"List users","description":"Returns a paginated list of users within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of users within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SearchText","in":"query","schemaId":"schema_23","description":"Filter users by a free-text search across given name, surname, and email."},{"name":"GivenName","in":"query","schemaId":"schema_23","description":"Filter users by given name."},{"name":"Surname","in":"query","schemaId":"schema_23","description":"Filter users by surname."},{"name":"Email","in":"query","schemaId":"schema_23","description":"Filter users by email address."},{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SortingKey","in":"query","schemaId":"schema_28","description":"The sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Whether to sort in ascending order."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/users","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"SearchText","in":"query","schemaId":"schema_23"},{"name":"GivenName","in":"query","schemaId":"schema_23"},{"name":"Surname","in":"query","schemaId":"schema_23"},{"name":"Email","in":"query","schemaId":"schema_23"},{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/UserSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users","href":"user/listusers","openApiOperationId":"listUsers","summary":"List users","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}},"schemaId":"components/schemas/UserListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listusers"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/createuser","routeSlug":"/products/namirialsignenterprise/openapi3/user/createuser","metadata":{"seo":{"title":"Create user","description":"Creates a new user within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create user","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/users","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users","href":"user/createuser","openApiOperationId":"createUser","summary":"Create user","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserResponse"}},"schemaId":"components/schemas/CreateUserResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/createuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users"},{"label":"Get user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/getuser","routeSlug":"/products/namirialsignenterprise/openapi3/user/getuser","metadata":{"seo":{"title":"Get user","description":"Returns a specific user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get user","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users/{userId}","href":"user/getuser","openApiOperationId":"getUser","summary":"Get user","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/getuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users/{userId}"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/updateuser","routeSlug":"/products/namirialsignenterprise/openapi3/user/updateuser","metadata":{"seo":{"title":"Update user","description":"Updates a specific user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update user","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users/{userId}","href":"user/updateuser","openApiOperationId":"updateUser","summary":"Update user","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/updateuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users/{userId}"},{"label":"Delete user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/deleteuser","routeSlug":"/products/namirialsignenterprise/openapi3/user/deleteuser","metadata":{"seo":{"title":"Delete user","description":"Deletes a user within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete user","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a user within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users/{userId}","href":"user/deleteuser","openApiOperationId":"deleteUser","summary":"Delete user","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/deleteuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users/{userId}"},{"label":"Update user application roles","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user/updateuserapplicationroles","routeSlug":"/products/namirialsignenterprise/openapi3/user/updateuserapplicationroles","metadata":{"seo":{"title":"Update user application roles","description":"Replaces the full set of application roles assigned to a user within the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserApplicationRoles","name":"Update user application roles","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user application roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the full set of application roles assigned to a user within the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserApplicationRolesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserApplicationRolesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/users/{userId}/application-roles","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserApplicationRolesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/users/{userId}/application-roles","href":"user/updateuserapplicationroles","openApiOperationId":"updateUserApplicationRoles","summary":"Update user application roles","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserApplicationRolesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserApplicationRolesRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/updateuserapplicationroles"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/users/{userId}/application-roles"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listusers","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/users","summary":"Create user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/createuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/users/{userId}","summary":"Get user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/getuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/users/{userId}","summary":"Update user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user/updateuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/users/{userId}","summary":"Delete user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/deleteuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/users/{userId}/application-roles","summary":"Update user application roles","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user/updateuserapplicationroles","deprecated":false}]}]}]}]}},{"type":"group","label":"User Group","link":"/products/namirialsignenterprise/openapi3/user-group","routeSlug":"/products/namirialsignenterprise/openapi3/user-group","items":[{"label":"List user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/listusergroups","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/listusergroups","metadata":{"seo":{"title":"List user groups","description":"Returns a paginated list of user groups for the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroups","name":"List user groups","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of user groups for the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."},{"name":"SearchText","in":"query","schemaId":"schema_23","description":"Optional free-text filter."},{"name":"SortingKey","in":"query","schemaId":"schema_29","description":"Optional sorting key."},{"name":"Ascending","in":"query","schemaId":"schema_4","description":"Optional sort direction."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"},{"name":"SearchText","in":"query","schemaId":"schema_23"},{"name":"SortingKey","in":"query","schemaId":"components/schemas/UserGroupsSortingKey"},{"name":"Ascending","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups","href":"user-group/listusergroups","openApiOperationId":"listUserGroups","summary":"List user groups","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/listusergroups"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups"},{"label":"Create user group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/createusergroup","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/createusergroup","metadata":{"seo":{"title":"Create user group","description":"Creates a new user group with the specified name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUserGroup","name":"Create user group","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user group with the specified name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/user-groups","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups","href":"user-group/createusergroup","openApiOperationId":"createUserGroup","summary":"Create user group","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserGroupResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateUserGroupResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateUserGroupResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserGroupResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/createusergroup"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups"},{"label":"Update user group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/updateusergroup","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/updateusergroup","metadata":{"seo":{"title":"Update user group","description":"Replaces the name of the specified user group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserGroup","name":"Update user group","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the name of the specified user group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","href":"user-group/updateusergroup","openApiOperationId":"updateUserGroup","summary":"Update user group","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/updateusergroup"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}"},{"label":"Delete user group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/deleteusergroup","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/deleteusergroup","metadata":{"seo":{"title":"Delete user group","description":"Deletes the specified user group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserGroup","name":"Delete user group","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified user group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","href":"user-group/deleteusergroup","openApiOperationId":"deleteUserGroup","summary":"Delete user group","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/deleteusergroup"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}"},{"label":"Lists the custom fields defined for the contacts of a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/listgroupcontactcustomfields","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/listgroupcontactcustomfields","metadata":{"seo":{"title":"Lists the custom fields defined for the contacts of a group.","description":"Returns the custom fields defined for the contacts of the group. Use their ids to read the custom field values of a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupContactCustomFields","name":"Lists the custom fields defined for the contacts of a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists the custom fields defined for the contacts of a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the custom fields defined for the contacts of the group. Use their ids to read the custom field values of a contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields","href":"user-group/listgroupcontactcustomfields","openApiOperationId":"listGroupContactCustomFields","summary":"Lists the custom fields defined for the contacts of a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactCustomFieldListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupContactCustomFieldListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupContactCustomFieldListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactCustomFieldListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/listgroupcontactcustomfields"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields"},{"label":"Lists users in a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/listusergroupusers","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/listusergroupusers","metadata":{"seo":{"title":"Lists users in a group.","description":"Returns a paginated list of users in the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroupUsers","name":"Lists users in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists users in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of users in the group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","href":"user-group/listusergroupusers","openApiOperationId":"listUserGroupUsers","summary":"Lists users in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupUserListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupUserListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupUserListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupUserListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/listusergroupusers"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users"},{"label":"Adds a user to a group.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/addusertogroup","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/addusertogroup","metadata":{"seo":{"title":"Adds a user to a group.","description":"Adds a user to the group with optional permissions and business role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUserToGroup","name":"Adds a user to a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a user to a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a user to the group with optional permissions and business role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddUserToGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AddUserToGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody","description":"Request containing user ID and optional permissions/role."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddUserToGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","href":"user-group/addusertogroup","openApiOperationId":"addUserToGroup","summary":"Adds a user to a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/AddUserToGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddUserToGroupRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/addusertogroup"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users"},{"label":"Gets details about a specific user in a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/getgroupuser","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/getgroupuser","metadata":{"seo":{"title":"Gets details about a specific user in a group.","description":"Returns details about a specific user in the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupUser","name":"Gets details about a specific user in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets details about a specific user in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details about a specific user in the group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","href":"user-group/getgroupuser","openApiOperationId":"getGroupUser","summary":"Gets details about a specific user in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupUserResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupUserResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupUserResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupUserResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/getgroupuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}"},{"label":"Updates a user's permissions and/or business role in a group.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/updategroupuser","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/updategroupuser","metadata":{"seo":{"title":"Updates a user's permissions and/or business role in a group.","description":"Updates a user's permissions and/or business role in the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroupUser","name":"Updates a user's permissions and/or business role in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a user's permissions and/or business role in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a user's permissions and/or business role in the group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserGroupUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody","description":"Request containing optional permissions and/or business role to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","href":"user-group/updategroupuser","openApiOperationId":"updateGroupUser","summary":"Updates a user's permissions and/or business role in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserGroupUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupUserRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/updategroupuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}"},{"label":"Removes a user from a group.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/deletegroupuser","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/deletegroupuser","metadata":{"seo":{"title":"Removes a user from a group.","description":"Removes a user from the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroupUser","name":"Removes a user from a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a user from a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a user from the group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","href":"user-group/deletegroupuser","openApiOperationId":"deleteGroupUser","summary":"Removes a user from a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/deletegroupuser"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}"},{"label":"Lists the contacts shared in a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/listgroupcontacts","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/listgroupcontacts","metadata":{"seo":{"title":"Lists the contacts shared in a group.","description":"Returns a paginated list of the contacts shared in the group, including their custom field values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupContacts","name":"Lists the contacts shared in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists the contacts shared in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of the contacts shared in the group, including their custom field values."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Page","in":"query","schemaId":"schema_2","description":"The page number."},{"name":"PageSize","in":"query","schemaId":"schema_2","description":"The number of items per page."}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"Page","in":"query","schemaId":"schema_2"},{"name":"PageSize","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","href":"user-group/listgroupcontacts","openApiOperationId":"listGroupContacts","summary":"Lists the contacts shared in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupContactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupContactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactListResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/listgroupcontacts"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts"},{"label":"Creates a contact in a group.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/creategroupcontact","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/creategroupcontact","metadata":{"seo":{"title":"Creates a contact in a group.","description":"Creates a contact in the group. The values of the group's custom fields are sent as additional properties next to the standard fields, keyed by custom field name; a property that is neither a standard field nor a custom field of the group is rejected with 422, a property sent more than once with 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroupContact","name":"Creates a contact in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a contact in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a contact in the group. The values of the group's custom fields are sent as additional properties next to the standard fields, keyed by custom field name; a property that is neither a standard field nor a custom field of the group is rejected with 422, a property sent more than once with 400."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"]}},"schemaId":"components/schemas/CreateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","href":"user-group/creategroupcontact","openApiOperationId":"createGroupContact","summary":"Creates a contact in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserGroupContactResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateUserGroupContactResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateUserGroupContactResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserGroupContactResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/creategroupcontact"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts"},{"label":"Gets a single contact shared in a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/getgroupcontact","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/getgroupcontact","metadata":{"seo":{"title":"Gets a single contact shared in a group.","description":"Returns a single contact shared in the group, including its custom field values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupContact","name":"Gets a single contact shared in a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a single contact shared in a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single contact shared in the group, including its custom field values."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"contactId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","href":"user-group/getgroupcontact","openApiOperationId":"getGroupContact","summary":"Gets a single contact shared in a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupContactSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupContactSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/getgroupcontact"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}"},{"label":"Replaces a contact of a group.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/updategroupcontact","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/updategroupcontact","metadata":{"seo":{"title":"Replaces a contact of a group.","description":"Replaces a contact of the group as a whole: a standard field or a custom field that is not sent is cleared. The values of the group's custom fields are sent as additional properties next to the standard fields, keyed by custom field name; a property that is neither a standard field nor a custom field of the group is rejected with 422, a property sent more than once with 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroupContact","name":"Replaces a contact of a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replaces a contact of a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces a contact of the group as a whole: a standard field or a custom field that is not sent is cleared. The values of the group's custom fields are sent as additional properties next to the standard fields, keyed by custom field name; a property that is neither a standard field nor a custom field of the group is rejected with 422, a property sent more than once with 400."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"contactId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"]}},"schemaId":"components/schemas/UpdateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","href":"user-group/updategroupcontact","openApiOperationId":"updateGroupContact","summary":"Replaces a contact of a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only","paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/updategroupcontact"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}"},{"label":"Deletes a contact from a group.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/deletegroupcontact","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/deletegroupcontact","metadata":{"seo":{"title":"Deletes a contact from a group.","description":"Deletes a contact from the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroupContact","name":"Deletes a contact from a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a contact from a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a contact from the group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"contactId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","href":"user-group/deletegroupcontact","openApiOperationId":"deleteGroupContact","summary":"Deletes a contact from a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/deletegroupcontact"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}"},{"label":"Gets a custom field defined for the contacts of a group.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/getgroupcontactcustomfield","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/getgroupcontactcustomfield","metadata":{"seo":{"title":"Gets a custom field defined for the contacts of a group.","description":"Returns the custom field identified by fieldId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupContactCustomField","name":"Gets a custom field defined for the contacts of a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a custom field defined for the contacts of a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the custom field identified by fieldId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"fieldId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact custom field.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fieldId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","href":"user-group/getgroupcontactcustomfield","openApiOperationId":"getGroupContactCustomField","summary":"Gets a custom field defined for the contacts of a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactCustomFieldSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserGroupContactCustomFieldSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroupContactCustomFieldSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroupContactCustomFieldSummary","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/getgroupcontactcustomfield"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}"},{"label":"Updates the name of a custom field defined for the contacts of a group.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/updategroupcontactcustomfield","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/updategroupcontactcustomfield","metadata":{"seo":{"title":"Updates the name of a custom field defined for the contacts of a group.","description":"Replaces the name of the custom field identified by fieldId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroupContactCustomField","name":"Updates the name of a custom field defined for the contacts of a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the name of a custom field defined for the contacts of a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the name of the custom field identified by fieldId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"fieldId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact custom field.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactCustomFieldRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserGroupContactCustomFieldRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody","description":"The replacement custom field name."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fieldId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactCustomFieldRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","href":"user-group/updategroupcontactcustomfield","openApiOperationId":"updateGroupContactCustomField","summary":"Updates the name of a custom field defined for the contacts of a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateUserGroupContactCustomFieldRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupContactCustomFieldRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/updategroupcontactcustomfield"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}"},{"label":"Deletes a custom field defined for the contacts of a group.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/user-group/deletegroupcontactcustomfield","routeSlug":"/products/namirialsignenterprise/openapi3/user-group/deletegroupcontactcustomfield","metadata":{"seo":{"title":"Deletes a custom field defined for the contacts of a group.","description":"Deletes the custom field identified by fieldId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroupContactCustomField","name":"Deletes a custom field defined for the contacts of a group.","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a custom field defined for the contacts of a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the custom field identified by fieldId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"userGroupId","in":"path","schemaId":"schema_0","description":"Unique identifier of the user group","required":true},{"name":"fieldId","in":"path","schemaId":"schema_0","description":"Unique identifier of the contact custom field.","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"userGroupId","in":"path","required":true,"schemaId":"schema_0"},{"name":"fieldId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","href":"user-group/deletegroupcontactcustomfield","openApiOperationId":"deleteGroupContactCustomField","summary":"Deletes a custom field defined for the contacts of a group.","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-group/deletegroupcontactcustomfield"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}"}],"content":{"contentType":"group","meta":{"name":"User Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Group","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/user-groups","summary":"List user groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/listusergroups","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups","summary":"Create user group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-group/createusergroup","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","summary":"Update user group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-group/updateusergroup","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}","summary":"Delete user group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-group/deleteusergroup","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields","summary":"Lists the custom fields defined for the contacts of a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/listgroupcontactcustomfields","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","summary":"Lists users in a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/listusergroupusers","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users","summary":"Adds a user to a group.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-group/addusertogroup","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","summary":"Gets details about a specific user in a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/getgroupuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","summary":"Updates a user's permissions and/or business role in a group.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-group/updategroupuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}","summary":"Removes a user from a group.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-group/deletegroupuser","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","summary":"Lists the contacts shared in a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/listgroupcontacts","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts","summary":"Creates a contact in a group.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-group/creategroupcontact","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","summary":"Gets a single contact shared in a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/getgroupcontact","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","summary":"Replaces a contact of a group.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-group/updategroupcontact","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}","summary":"Deletes a contact from a group.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-group/deletegroupcontact","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","summary":"Gets a custom field defined for the contacts of a group.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group/getgroupcontactcustomfield","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","summary":"Updates the name of a custom field defined for the contacts of a group.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-group/updategroupcontactcustomfield","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}","summary":"Deletes a custom field defined for the contacts of a group.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-group/deletegroupcontactcustomfield","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook","link":"/products/namirialsignenterprise/openapi3/webhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook","items":[{"label":"List envelope webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/listenvelopewebhooks","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/listenvelopewebhooks","metadata":{"seo":{"title":"List envelope webhooks","description":"Returns the webhooks of the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnvelopeWebhooks","name":"List envelope webhooks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List envelope webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the webhooks of the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","href":"webhook/listenvelopewebhooks","openApiOperationId":"listEnvelopeWebhooks","summary":"List envelope webhooks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeWebhookListResponse"}},"schemaId":"components/schemas/EnvelopeWebhookListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeWebhookListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeWebhookListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/listenvelopewebhooks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks"},{"label":"Create envelope webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/createenvelopewebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/createenvelopewebhook","metadata":{"seo":{"title":"Create envelope webhook","description":"Creates a new webhook for the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnvelopeWebhook","name":"Create envelope webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create envelope webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new webhook for the specified envelope."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"schemaId":"components/schemas/CreateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","href":"webhook/createenvelopewebhook","openApiOperationId":"createEnvelopeWebhook","summary":"Create envelope webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeWebhookResponse"}},"schemaId":"components/schemas/CreateEnvelopeWebhookResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEnvelopeWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEnvelopeWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/createenvelopewebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks"},{"label":"Get envelope webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/getenvelopewebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/getenvelopewebhook","metadata":{"seo":{"title":"Get envelope webhook","description":"Returns a specific envelope webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnvelopeWebhook","name":"Get envelope webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get envelope webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific envelope webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","href":"webhook/getenvelopewebhook","openApiOperationId":"getEnvelopeWebhook","summary":"Get envelope webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EnvelopeWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnvelopeWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/getenvelopewebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}"},{"label":"Update envelope webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/updateenvelopewebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/updateenvelopewebhook","metadata":{"seo":{"title":"Update envelope webhook","description":"Replaces a specific envelope webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnvelopeWebhook","name":"Update envelope webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update envelope webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces a specific envelope webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","href":"webhook/updateenvelopewebhook","openApiOperationId":"updateEnvelopeWebhook","summary":"Update envelope webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEnvelopeWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/updateenvelopewebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}"},{"label":"Delete envelope webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/deleteenvelopewebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/deleteenvelopewebhook","metadata":{"seo":{"title":"Delete envelope webhook","description":"Deletes a specific envelope webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnvelopeWebhook","name":"Delete envelope webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete envelope webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific envelope webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","href":"webhook/deleteenvelopewebhook","openApiOperationId":"deleteEnvelopeWebhook","summary":"Delete envelope webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/deleteenvelopewebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}"},{"label":"List organization webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/listorganizationwebhooks","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/listorganizationwebhooks","metadata":{"seo":{"title":"List organization webhooks","description":"Returns the webhooks of the specified organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrganizationWebhooks","name":"List organization webhooks","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List organization webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the webhooks of the specified organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/webhooks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/webhooks","href":"webhook/listorganizationwebhooks","openApiOperationId":"listOrganizationWebhooks","summary":"List organization webhooks","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationWebhookListResponse"}},"schemaId":"components/schemas/OrganizationWebhookListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationWebhookListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationWebhookListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/listorganizationwebhooks"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/webhooks"},{"label":"Create organization webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/createorganizationwebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/createorganizationwebhook","metadata":{"seo":{"title":"Create organization webhook","description":"Creates a new webhook for the specified organization. Only the EnvelopeCompleted event is supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrganizationWebhook","name":"Create organization webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create organization webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new webhook for the specified organization. Only the EnvelopeCompleted event is supported."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"schemaId":"components/schemas/CreateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/webhooks","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/webhooks","href":"webhook/createorganizationwebhook","openApiOperationId":"createOrganizationWebhook","summary":"Create organization webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication","paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookResponse"}},"schemaId":"components/schemas/CreateOrganizationWebhookResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateOrganizationWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrganizationWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/createorganizationwebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/webhooks"},{"label":"Get organization webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/getorganizationwebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/getorganizationwebhook","metadata":{"seo":{"title":"Get organization webhook","description":"Returns a specific organization webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationWebhook","name":"Get organization webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific organization webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","href":"webhook/getorganizationwebhook","openApiOperationId":"getOrganizationWebhook","summary":"Get organization webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/OrganizationWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationWebhookResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/getorganizationwebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}"},{"label":"Update organization webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/updateorganizationwebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/updateorganizationwebhook","metadata":{"seo":{"title":"Update organization webhook","description":"Replaces a specific organization webhook. Only the EnvelopeCompleted event is supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganizationWebhook","name":"Update organization webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces a specific organization webhook. Only the EnvelopeCompleted event is supported."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","href":"webhook/updateorganizationwebhook","openApiOperationId":"updateOrganizationWebhook","summary":"Update organization webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/UpdateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrganizationWebhookRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/updateorganizationwebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}"},{"label":"Delete organization webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/deleteorganizationwebhook","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/deleteorganizationwebhook","metadata":{"seo":{"title":"Delete organization webhook","description":"Deletes a specific organization webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrganizationWebhook","name":"Delete organization webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete organization webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific organization webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"webhookId","in":"path","schemaId":"schema_0","description":"Unique identifier of the webhook","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","href":"webhook/deleteorganizationwebhook","openApiOperationId":"deleteOrganizationWebhook","summary":"Delete organization webhook","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/deleteorganizationwebhook"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}"},{"label":"Get webhook subscription (deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/getwebhooksubscription","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/getwebhooksubscription","metadata":{"seo":{"title":"Get webhook subscription (deprecated)","description":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Returns the webhook subscription for the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhookSubscription","name":"Get webhook subscription (deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook subscription (deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Returns the webhook subscription for the specified envelope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","href":"webhook/getwebhooksubscription","openApiOperationId":"getWebhookSubscription","summary":"Get webhook subscription (deprecated)","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/getwebhooksubscription"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription"},{"label":"Create webhook subscription (deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/createwebhooksubscription","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/createwebhooksubscription","metadata":{"seo":{"title":"Create webhook subscription (deprecated)","description":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Creates a webhook subscription for the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhookSubscription","name":"Create webhook subscription (deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhook subscription (deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Creates a webhook subscription for the specified envelope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookSubscriptionRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","href":"webhook/createwebhooksubscription","openApiOperationId":"createWebhookSubscription","summary":"Create webhook subscription (deprecated)","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/CreateWebhookSubscriptionRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionRequest","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionResponse","exampleIds":["paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/createwebhooksubscription"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription"},{"label":"Delete webhook subscription (deprecated)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialsignenterprise/openapi3/webhook/deletewebhooksubscription","routeSlug":"/products/namirialsignenterprise/openapi3/webhook/deletewebhooksubscription","metadata":{"seo":{"title":"Delete webhook subscription (deprecated)","description":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Deletes the webhook subscription for the specified envelope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhookSubscription","name":"Delete webhook subscription (deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook subscription (deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Deletes the webhook subscription for the specified envelope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"}]},{"schemes":[{"name":"PersonalAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Personal-Access-Token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_0","description":"Unique identifier of the organization","required":true},{"name":"envelopeId","in":"path","schemaId":"schema_0","description":"Unique identifier of the envelope","required":true}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","servers":[{"url":"/"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"envelopeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalAccessToken","type":"apiKey","name":"Personal-Access-Token","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","href":"webhook/deletewebhooksubscription","openApiOperationId":"deleteWebhookSubscription","summary":"Delete webhook subscription (deprecated)","securityGroups":[{"Bearer":[]},{"PersonalAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}},"schemaId":"components/schemas/ErrorsResponse"}],"pointer":"/paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/deletewebhooksubscription"}],"panels":[]}]},"httpPath":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription"}],"content":{"contentType":"group","meta":{"name":"Webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","summary":"List envelope webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/listenvelopewebhooks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks","summary":"Create envelope webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/createenvelopewebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","summary":"Get envelope webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/getenvelopewebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","summary":"Update envelope webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhook/updateenvelopewebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}","summary":"Delete envelope webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/deleteenvelopewebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/webhooks","summary":"List organization webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/listorganizationwebhooks","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/webhooks","summary":"Create organization webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/createorganizationwebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","summary":"Get organization webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/getorganizationwebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","summary":"Update organization webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhook/updateorganizationwebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/webhooks/{webhookId}","summary":"Delete organization webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/deleteorganizationwebhook","deprecated":false},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","summary":"Get webhook subscription (deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/webhook/getwebhooksubscription","deprecated":true},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","summary":"Create webhook subscription (deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/webhook/createwebhooksubscription","deprecated":true},{"title":"/api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription","summary":"Delete webhook subscription (deprecated)","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/webhook/deletewebhooksubscription","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AbsoluteBulkEnvelopeExpirationResponse":{"id":"components/schemas/AbsoluteBulkEnvelopeExpirationResponse","kind":"json-schema","title":"AbsoluteBulkEnvelopeExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration."}},"components/schemas/AbsoluteCreateBulkEnvelopeExpiration":{"id":"components/schemas/AbsoluteCreateBulkEnvelopeExpiration","kind":"json-schema","title":"AbsoluteCreateBulkEnvelopeExpiration","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration."}},"components/schemas/AbsoluteCreateEnvelopeExpiration":{"id":"components/schemas/AbsoluteCreateEnvelopeExpiration","kind":"json-schema","title":"AbsoluteCreateEnvelopeExpiration","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration.","example":{"expiresAt":"2026-12-11T14:00:03.1736798+00:00","mode":"Absolute"}}},"components/schemas/AbsoluteCreateTemplateExpiration":{"id":"components/schemas/AbsoluteCreateTemplateExpiration","kind":"json-schema","title":"AbsoluteCreateTemplateExpiration","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration.","example":{"expiresAt":"2026-12-11T14:00:03.3549182+00:00","mode":"Absolute"}}},"components/schemas/AbsoluteEnvelopeExpirationResponse":{"id":"components/schemas/AbsoluteEnvelopeExpirationResponse","kind":"json-schema","title":"AbsoluteEnvelopeExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration."}},"components/schemas/AbsoluteTemplateExpirationResponse":{"id":"components/schemas/AbsoluteTemplateExpirationResponse","kind":"json-schema","title":"AbsoluteTemplateExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration."}},"components/schemas/AbsoluteUpdateBulkEnvelopeExpirationRequest":{"id":"components/schemas/AbsoluteUpdateBulkEnvelopeExpirationRequest","kind":"json-schema","title":"AbsoluteUpdateBulkEnvelopeExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration."}},"components/schemas/AbsoluteUpdateEnvelopeExpirationRequest":{"id":"components/schemas/AbsoluteUpdateEnvelopeExpirationRequest","kind":"json-schema","title":"AbsoluteUpdateEnvelopeExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration.","example":{"expiresAt":"2026-12-11T14:00:03.1819007+00:00","mode":"Absolute"}}},"components/schemas/AbsoluteUpdateTemplateExpirationRequest":{"id":"components/schemas/AbsoluteUpdateTemplateExpirationRequest","kind":"json-schema","title":"AbsoluteUpdateTemplateExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"expiresAt":{"type":"string","description":"The exact expiration date and time.","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"mode":{"enum":["Absolute"],"type":"string","default":"Absolute"}},"additionalProperties":false,"description":"Absolute expiration configuration.","example":{"expiresAt":"2026-12-11T14:00:03.3640648+00:00","mode":"Absolute"}}},"components/schemas/AccessCode":{"id":"components/schemas/AccessCode","kind":"json-schema","title":"AccessCode","data":{"type":"object","properties":{"code":{"type":"string","description":"The access code.","nullable":true}},"additionalProperties":false,"description":"Access code configuration."}},"components/schemas/AddEnvelopeStageConfigurationActionRequest":{"id":"components/schemas/AddEnvelopeStageConfigurationActionRequest","kind":"json-schema","title":"AddEnvelopeStageConfigurationActionRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyActionRequest"},{"required":["recipientSource","stage"],"type":"object","properties":{"stage":{"$ref":"#/components/schemas/StageConfigurationRequest"},"recipientSource":{"oneOf":[{"$ref":"#/components/schemas/StaticPolicyRecipientSourceRequest"},{"$ref":"#/components/schemas/DynamicPolicyRecipientSourceRequest"},{"enum":[null],"nullable":true}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action's recipient source, discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"additionalProperties":false}],"properties":{"type":{"enum":["AddEnvelopeStageConfiguration"],"type":"string","default":"AddEnvelopeStageConfiguration"}},"description":"Adds a stage configuration to the envelope."}},"components/schemas/AddUserGroupContactsPermissionRequest":{"id":"components/schemas/AddUserGroupContactsPermissionRequest","kind":"json-schema","title":"AddUserGroupContactsPermissionRequest","data":{"type":"object","properties":{"read":{"type":"boolean","description":"Whether the user has permission to read contacts.","nullable":true},"createUpdateDelete":{"type":"boolean","description":"Whether the user has permission to create, update, and delete contacts.","nullable":true},"customize":{"type":"boolean","description":"Whether the user has permission to customize contacts.","nullable":true}},"additionalProperties":false,"description":"Contacts management permissions."}},"components/schemas/AddUserGroupEnvelopesPermissionRequest":{"id":"components/schemas/AddUserGroupEnvelopesPermissionRequest","kind":"json-schema","title":"AddUserGroupEnvelopesPermissionRequest","data":{"type":"object","properties":{"share":{"type":"boolean","description":"Whether the user has permission to share envelopes.","nullable":true},"manage":{"type":"boolean","description":"Whether the user has permission to manage envelopes.","nullable":true}},"additionalProperties":false,"description":"Envelopes management permissions."}},"components/schemas/AddUserGroupPermissionRequest":{"id":"components/schemas/AddUserGroupPermissionRequest","kind":"json-schema","title":"AddUserGroupPermissionRequest","data":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/AddUserGroupUsersPermissionRequest"},"envelopes":{"$ref":"#/components/schemas/AddUserGroupEnvelopesPermissionRequest"},"templates":{"$ref":"#/components/schemas/AddUserGroupTemplatesPermissionRequest"},"contacts":{"$ref":"#/components/schemas/AddUserGroupContactsPermissionRequest"}},"additionalProperties":false,"description":"Permissions for a user in a group."}},"components/schemas/AddUserGroupTemplatesPermissionRequest":{"id":"components/schemas/AddUserGroupTemplatesPermissionRequest","kind":"json-schema","title":"AddUserGroupTemplatesPermissionRequest","data":{"type":"object","properties":{"share":{"type":"boolean","description":"Whether the user has permission to share templates.","nullable":true},"manage":{"type":"boolean","description":"Whether the user has permission to manage templates.","nullable":true}},"additionalProperties":false,"description":"Templates management permissions."}},"components/schemas/AddUserGroupUsersPermissionRequest":{"id":"components/schemas/AddUserGroupUsersPermissionRequest","kind":"json-schema","title":"AddUserGroupUsersPermissionRequest","data":{"type":"object","properties":{"read":{"type":"boolean","description":"Whether the user has permission to read users.","nullable":true},"createUpdateDelete":{"type":"boolean","description":"Whether the user has permission to create, update, and delete users.","nullable":true}},"additionalProperties":false,"description":"Users management permissions."}},"components/schemas/AddUserToGroupRequest":{"id":"components/schemas/AddUserToGroupRequest","kind":"json-schema","title":"AddUserToGroupRequest","data":{"required":["userId"],"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user to add.","format":"uuid"},"permissions":{"$ref":"#/components/schemas/AddUserGroupPermissionRequest"},"businessRoleId":{"type":"string","description":"Optional business role to assign to the user.","format":"uuid","nullable":true}},"additionalProperties":false,"description":"Request to add a user to a group."}},"components/schemas/Agreement":{"id":"components/schemas/Agreement","kind":"json-schema","title":"Agreement","data":{"required":["body","language"],"type":"object","properties":{"language":{"type":"string","description":"The BCP-47 language code for this agreement.","example":"en"},"title":{"type":"string","description":"The agreement title, or null when not set.","nullable":true,"example":"Please review the agreement"},"body":{"type":"string","description":"The agreement body.","example":"Please read and accept the agreement."}},"additionalProperties":false,"description":"A single agreement configuration for a specific language."}},"components/schemas/AgreementSettings":{"id":"components/schemas/AgreementSettings","kind":"json-schema","title":"AgreementSettings","data":{"required":["agreements","enabled","overridable"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the standard agreement text applies to all envelopes sent by the organization."},"overridable":{"type":"boolean","description":"Whether senders are allowed to override the standard agreement text at envelope or template level."},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The configured agreement texts, one per organization-enabled language."}},"additionalProperties":false,"description":"The organization's envelope agreement configuration."}},"components/schemas/AnnotationField":{"id":"components/schemas/AnnotationField","kind":"json-schema","title":"AnnotationField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"required":["annotationConfig"],"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"annotationConfig":{"oneOf":[{"$ref":"#/components/schemas/FullNameAnnotationValueFormat"},{"$ref":"#/components/schemas/FirstNameAnnotationValueFormat"},{"$ref":"#/components/schemas/LastNameAnnotationValueFormat"},{"$ref":"#/components/schemas/InitialsAnnotationValueFormat"},{"$ref":"#/components/schemas/EmailAnnotationValueFormat"},{"$ref":"#/components/schemas/DateAnnotationValueFormat"},{"$ref":"#/components/schemas/TextAnnotationValueFormat"},{"enum":[null],"nullable":true}],"description":"The annotation configuration."},"font":{"$ref":"#/components/schemas/FontStyle"},"elementName":{"type":"string","description":"The name of the element.","nullable":true}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Annotation"],"type":"string","default":"Annotation"}},"description":"An annotation field.","example":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Text"},"positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"}}},"components/schemas/AnnotationType":{"id":"components/schemas/AnnotationType","kind":"json-schema","title":"AnnotationType","data":{"enum":["FullName","FirstName","LastName","Initials","Email","Date","Text"],"type":"string","description":"Identifies the type of annotation field."}},"components/schemas/ApplicationRoleListResponse":{"id":"components/schemas/ApplicationRoleListResponse","kind":"json-schema","title":"ApplicationRoleListResponse","data":{"required":["applicationRoles","pagination"],"type":"object","properties":{"applicationRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRoleSummary"},"description":"The list of application roles."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of application roles."}},"components/schemas/ApplicationRoleResponse":{"id":"components/schemas/ApplicationRoleResponse","kind":"json-schema","title":"ApplicationRoleResponse","data":{"required":["id","isSystemRole","name","permissions"],"type":"object","properties":{"id":{"type":"string","description":"The application role ID.","format":"uuid","example":"6f2ed3d2-0617-4be4-9445-7e6a4090b260"},"name":{"type":"string","description":"The application role name.","example":"Administrator"},"description":{"type":"string","description":"The application role description.","nullable":true,"example":"Can read envelopes"},"isSystemRole":{"type":"boolean","description":"Whether the application role is a built-in system role.","example":false},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"},"description":"The list of entity/action permission pairs granted by the application role."}},"additionalProperties":false,"description":"Response model for an application role's full details."}},"components/schemas/ApplicationRoleSortingKey":{"id":"components/schemas/ApplicationRoleSortingKey","kind":"json-schema","title":"ApplicationRoleSortingKey","data":{"enum":["Id","Name"],"type":"string","description":"The available sorting keys for listing application roles."}},"components/schemas/ApplicationRoleSummary":{"id":"components/schemas/ApplicationRoleSummary","kind":"json-schema","title":"ApplicationRoleSummary","data":{"required":["id","isSystemRole","name"],"type":"object","properties":{"id":{"type":"string","description":"The application role ID.","format":"uuid","example":"6f2ed3d2-0617-4be4-9445-7e6a4090b260"},"name":{"type":"string","description":"The application role name.","example":"Administrator"},"description":{"type":"string","description":"The application role description.","nullable":true,"example":"Can read envelopes"},"isSystemRole":{"type":"boolean","description":"Whether the application role is a built-in system role.","example":false}},"additionalProperties":false,"description":"Summary representation of an application role."}},"components/schemas/ApprovalField":{"id":"components/schemas/ApprovalField","kind":"json-schema","title":"ApprovalField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"required":{"type":"boolean","description":"Whether the field is required."},"layoutId":{"type":"string","description":"The optional identifier of the signature layout applied to this field, one of the organization's signature layouts. When omitted, the organization default layout is used.","format":"uuid","nullable":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Approval"],"type":"string","default":"Approval"}},"description":"An approval field.","example":{"fieldType":"Approval","required":false,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"app1"}}},"components/schemas/AreaReadConfirmationField":{"id":"components/schemas/AreaReadConfirmationField","kind":"json-schema","title":"AreaReadConfirmationField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["AreaReadConfirmation"],"type":"string","default":"AreaReadConfirmation"}},"description":"An area read confirmation field.","example":{"fieldType":"AreaReadConfirmation","required":false,"positionX":50,"positionY":250,"width":200,"height":100,"page":1,"id":"arc1"}}},"components/schemas/AttachmentField":{"id":"components/schemas/AttachmentField","kind":"json-schema","title":"AttachmentField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Attachment"],"type":"string","default":"Attachment"}},"description":"An attachment field.","example":{"fieldType":"Attachment","required":false,"positionX":50,"positionY":600,"width":100,"height":30,"page":1,"id":"att1"}}},"components/schemas/AuditTrailMode":{"id":"components/schemas/AuditTrailMode","kind":"json-schema","title":"AuditTrailMode","data":{"enum":["Standard","PDF/A-2b"],"type":"string","description":"The audit trail generation modes supported by the settings/signature endpoint."}},"components/schemas/AuditTrailModeOptional":{"id":"components/schemas/AuditTrailModeOptional","kind":"json-schema","title":"AuditTrailModeOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/AuditTrailMode"}},"additionalProperties":false}},"components/schemas/AuthenticationOneTimePassword":{"id":"components/schemas/AuthenticationOneTimePassword","kind":"json-schema","title":"AuthenticationOneTimePassword","data":{"required":["channel"],"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OneTimePasswordAuthenticationChannel"}},"additionalProperties":false,"description":"OTP authentication configuration."}},"components/schemas/AutomaticSignature":{"id":"components/schemas/AutomaticSignature","kind":"json-schema","title":"AutomaticSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["AutomaticSignature"],"type":"string","default":"AutomaticSignature"}},"additionalProperties":false,"description":"Automatic signature configuration.","example":{"signatureType":"AutomaticSignature"}}},"components/schemas/BaseField":{"id":"components/schemas/BaseField","kind":"json-schema","title":"BaseField","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The field ID."}},"additionalProperties":false,"description":"Base definition of a field on a file page."}},"components/schemas/BiometricSignature":{"id":"components/schemas/BiometricSignature","kind":"json-schema","title":"BiometricSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["BiometricSignature"],"type":"string","default":"BiometricSignature"}},"additionalProperties":false,"description":"Biometric signature configuration.","example":{"signatureType":"BiometricSignature"}}},"components/schemas/BooleanOptional":{"id":"components/schemas/BooleanOptional","kind":"json-schema","title":"BooleanOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"type":"boolean","readOnly":true}},"additionalProperties":false}},"components/schemas/BulkEnvelopeChildEnvelopeListResponse":{"id":"components/schemas/BulkEnvelopeChildEnvelopeListResponse","kind":"json-schema","title":"BulkEnvelopeChildEnvelopeListResponse","data":{"required":["envelopes","pagination"],"type":"object","properties":{"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeChildEnvelopeSummary"},"description":"The list of child envelopes."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of child envelopes generated by a bulk envelope send."}},"components/schemas/BulkEnvelopeChildEnvelopeSummary":{"id":"components/schemas/BulkEnvelopeChildEnvelopeSummary","kind":"json-schema","title":"BulkEnvelopeChildEnvelopeSummary","data":{"required":["createdAt","id","name","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The envelope ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"The envelope name.","example":"Contract for Mario Rossi"},"status":{"type":"string","description":"The current status of the envelope.","example":"Draft"},"createdAt":{"type":"string","description":"When the envelope was created.","format":"date-time","example":"2025-01-01T10:00:00Z"},"updatedAt":{"type":"string","description":"When the envelope was last updated.","format":"date-time","example":"2025-01-01T10:00:00Z"},"sentAt":{"type":"string","description":"When the envelope was sent.","format":"date-time","nullable":true,"example":"2025-01-02T12:00:00Z"}},"additionalProperties":false,"description":"Summary representation of a child envelope generated by a bulk envelope send."}},"components/schemas/BulkEnvelopeFieldTask":{"id":"components/schemas/BulkEnvelopeFieldTask","kind":"json-schema","title":"BulkEnvelopeFieldTask","data":{"required":["field","sortOrder","source"],"type":"object","properties":{"field":{"oneOf":[{"$ref":"#/components/schemas/SignatureField"},{"$ref":"#/components/schemas/TextInputField"},{"$ref":"#/components/schemas/CheckboxField"},{"$ref":"#/components/schemas/DropDownField"},{"$ref":"#/components/schemas/ListBoxField"},{"$ref":"#/components/schemas/AttachmentField"},{"$ref":"#/components/schemas/LinkField"},{"$ref":"#/components/schemas/FileReadConfirmationField"},{"$ref":"#/components/schemas/PageReadConfirmationField"},{"$ref":"#/components/schemas/AreaReadConfirmationField"},{"$ref":"#/components/schemas/ApprovalField"},{"$ref":"#/components/schemas/AnnotationField"},{"$ref":"#/components/schemas/RadioButtonField"},{"$ref":"#/components/schemas/InvisibleSignatureField"}],"description":"The field definition."},"recipientId":{"type":"string","description":"The ID of the recipient assigned to this task.","format":"uuid","nullable":true},"stageId":{"type":"string","description":"The ID of the Bulk Stage assigned to this task, when the task is not assigned to a specific recipient.","format":"uuid","nullable":true},"sortOrder":{"type":"integer","description":"The position of the task in the sequence.","format":"int32"},"source":{"$ref":"#/components/schemas/ElementSource"}},"additionalProperties":false,"description":"A task assigned to a field on a bulk-envelope file."}},"components/schemas/BulkEnvelopeFieldTaskListResponse":{"id":"components/schemas/BulkEnvelopeFieldTaskListResponse","kind":"json-schema","title":"BulkEnvelopeFieldTaskListResponse","data":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeFieldTask"},"description":"The list of tasks."}},"additionalProperties":false,"description":"List of field tasks of a bulk-envelope file."}},"components/schemas/BulkEnvelopeFieldTaskRequest":{"id":"components/schemas/BulkEnvelopeFieldTaskRequest","kind":"json-schema","title":"BulkEnvelopeFieldTaskRequest","data":{"required":["field","sortOrder"],"type":"object","properties":{"field":{"oneOf":[{"$ref":"#/components/schemas/SignatureField"},{"$ref":"#/components/schemas/TextInputField"},{"$ref":"#/components/schemas/CheckboxField"},{"$ref":"#/components/schemas/DropDownField"},{"$ref":"#/components/schemas/ListBoxField"},{"$ref":"#/components/schemas/AttachmentField"},{"$ref":"#/components/schemas/LinkField"},{"$ref":"#/components/schemas/FileReadConfirmationField"},{"$ref":"#/components/schemas/PageReadConfirmationField"},{"$ref":"#/components/schemas/AreaReadConfirmationField"},{"$ref":"#/components/schemas/ApprovalField"},{"$ref":"#/components/schemas/AnnotationField"},{"$ref":"#/components/schemas/RadioButtonField"},{"$ref":"#/components/schemas/InvisibleSignatureField"}],"description":"The field definition."},"recipientId":{"type":"string","description":"The ID of the recipient assigned to this task.","format":"uuid","nullable":true},"stageId":{"type":"string","description":"The ID of the Bulk Stage assigned to this task, when the task is not assigned to a specific recipient.","format":"uuid","nullable":true},"sortOrder":{"type":"integer","description":"The position of the task in the sequence.","format":"int32"}},"additionalProperties":false,"description":"A task assigned to a field on a bulk-envelope file, as submitted by the client."}},"components/schemas/BulkEnvelopeFileDetailResponse":{"id":"components/schemas/BulkEnvelopeFileDetailResponse","kind":"json-schema","title":"BulkEnvelopeFileDetailResponse","data":{"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/BulkEnvelopeFileDocumentClassResponse"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file, or null if not set.","nullable":true}},"additionalProperties":false,"description":"Response containing details of a bulk envelope file."}},"components/schemas/BulkEnvelopeFileDocumentClassResponse":{"id":"components/schemas/BulkEnvelopeFileDocumentClassResponse","kind":"json-schema","title":"BulkEnvelopeFileDocumentClassResponse","data":{"required":["id","metadata"],"type":"object","properties":{"id":{"type":"string","description":"The assigned document class ID.","format":"uuid"},"name":{"type":"string","description":"The document class name, or null if none is assigned.","nullable":true},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringFileMetadataValueResponse"},{"$ref":"#/components/schemas/NumberFileMetadataValueResponse"},{"$ref":"#/components/schemas/DateFileMetadataValueResponse"},{"$ref":"#/components/schemas/ListOptionFileMetadataValueResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value of a file. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata field values for this file."}},"additionalProperties":false,"description":"Response containing the document class assigned to a bulk envelope file."}},"components/schemas/BulkEnvelopeFileListResponse":{"id":"components/schemas/BulkEnvelopeFileListResponse","kind":"json-schema","title":"BulkEnvelopeFileListResponse","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeFileSummaryResponse"},"description":"The list of files."}},"additionalProperties":false,"description":"List of bulk envelope files."}},"components/schemas/BulkEnvelopeFileSummaryResponse":{"id":"components/schemas/BulkEnvelopeFileSummaryResponse","kind":"json-schema","title":"BulkEnvelopeFileSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000020"},"name":{"type":"string","description":"The file name.","example":"contract.pdf"},"sortOrder":{"type":"integer","description":"The file sort order.","format":"int32","example":1}},"additionalProperties":false,"description":"Summary of a bulk envelope file."}},"components/schemas/BulkEnvelopeListResponse":{"id":"components/schemas/BulkEnvelopeListResponse","kind":"json-schema","title":"BulkEnvelopeListResponse","data":{"required":["bulkEnvelopes","pagination"],"type":"object","properties":{"bulkEnvelopes":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeSummary"},"description":"The list of bulk envelopes."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of bulk envelopes."}},"components/schemas/BulkEnvelopeReminderResponse":{"id":"components/schemas/BulkEnvelopeReminderResponse","kind":"json-schema","title":"BulkEnvelopeReminderResponse","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/BulkEnvelopeResponse":{"id":"components/schemas/BulkEnvelopeResponse","kind":"json-schema","title":"BulkEnvelopeResponse","data":{"required":["createdAt","fileRestrictedVisibility","files","id","qualifiedTimeStamp","signatureFormat","stages","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The bulk envelope ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"The bulk envelope name.","nullable":true,"example":"Bulk contract for onboarding"},"status":{"type":"string","description":"The current status of the bulk envelope.","example":"Draft"},"createdAt":{"type":"string","description":"When the bulk envelope was created.","format":"date-time","example":"2025-01-01T10:00:00Z"},"updatedAt":{"type":"string","description":"When the bulk envelope was last updated.","format":"date-time","example":"2025-01-01T10:00:00Z"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteBulkEnvelopeExpirationResponse"},{"$ref":"#/components/schemas/RelativeBulkEnvelopeExpirationResponse"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/BulkEnvelopeReminderResponse"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeStageSummaryResponse"},"description":"The stages of the bulk envelope."},"files":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeFileSummaryResponse"},"description":"The files of the bulk envelope."},"sentAt":{"type":"string","description":"When the bulk envelope was sent.","format":"date-time","nullable":true,"example":"2025-01-02T12:00:00Z"},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the bulk envelope must use a qualified timestamp server.","example":true},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"signatureReason":{"type":"string","description":"The signature reason persisted on the bulk envelope, or null.","nullable":true,"example":"Approved by Mario Rossi"},"statusChangeReason":{"type":"string","description":"The reason for the bulk envelope's terminal status change, otherwise null.","nullable":true,"example":"Document no longer required"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language, or null when no custom agreements are configured.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient.","example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the bulk envelope.","nullable":true,"example":"https://example.com/bulk-envelope-sent"}},"additionalProperties":false,"description":"Detailed representation of a bulk envelope parent."}},"components/schemas/BulkEnvelopeSortingKey":{"id":"components/schemas/BulkEnvelopeSortingKey","kind":"json-schema","title":"BulkEnvelopeSortingKey","data":{"enum":["LastUpdated","Name"],"type":"string","description":"The available sorting keys for listing bulk envelopes."}},"components/schemas/BulkEnvelopeStageAutomaticRecipientSummary":{"id":"components/schemas/BulkEnvelopeStageAutomaticRecipientSummary","kind":"json-schema","title":"BulkEnvelopeStageAutomaticRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/BulkEnvelopeStageRecipientSummary"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile used for automatic signing.","nullable":true,"example":"default-eseal-profile"}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Stage summary for an Automatic signer recipient."}},"components/schemas/BulkEnvelopeStageListResponse":{"id":"components/schemas/BulkEnvelopeStageListResponse","kind":"json-schema","title":"BulkEnvelopeStageListResponse","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeStageSummary"},"description":"The list of stages."}},"additionalProperties":false,"description":"List of bulk envelope stages."}},"components/schemas/BulkEnvelopeStageRecipientResponse":{"id":"components/schemas/BulkEnvelopeStageRecipientResponse","kind":"json-schema","title":"BulkEnvelopeStageRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"},"languageCode":{"type":"string","description":"The language code for the recipient's notifications.","nullable":true,"example":"en"},"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/RecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/RecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false,"description":"Detailed representation of a Standard recipient on a bulk envelope stage."}},"components/schemas/BulkEnvelopeStageRecipientSummary":{"id":"components/schemas/BulkEnvelopeStageRecipientSummary","kind":"json-schema","title":"BulkEnvelopeStageRecipientSummary","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"}},"additionalProperties":false,"description":"Summary representation of a bulk envelope stage recipient. Base for polymorphic response."}},"components/schemas/BulkEnvelopeStageResponse":{"id":"components/schemas/BulkEnvelopeStageResponse","kind":"json-schema","title":"BulkEnvelopeStageResponse","data":{"required":["id","mode","name","recipients","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"},"mode":{"$ref":"#/components/schemas/StageMode"},"recipients":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BulkEnvelopeStageStandardRecipientSummary"},{"$ref":"#/components/schemas/BulkEnvelopeStageAutomaticRecipientSummary"}],"description":"Summary representation of a bulk envelope stage recipient. Base for polymorphic response."},"description":"The recipients of the stage."}},"additionalProperties":false,"description":"Detailed representation of a bulk envelope stage."}},"components/schemas/BulkEnvelopeStageSortOrder":{"id":"components/schemas/BulkEnvelopeStageSortOrder","kind":"json-schema","title":"BulkEnvelopeStageSortOrder","data":{"required":["id","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"sortOrder":{"type":"integer","description":"The new position of the stage.","format":"int32","example":1}},"additionalProperties":false,"description":"Sort order entry for a bulk envelope stage."}},"components/schemas/BulkEnvelopeStageStandardRecipientSummary":{"id":"components/schemas/BulkEnvelopeStageStandardRecipientSummary","kind":"json-schema","title":"BulkEnvelopeStageStandardRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/BulkEnvelopeStageRecipientSummary"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Stage summary for a standard recipient."}},"components/schemas/BulkEnvelopeStageSummary":{"id":"components/schemas/BulkEnvelopeStageSummary","kind":"json-schema","title":"BulkEnvelopeStageSummary","data":{"required":["id","mode","name","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"},"mode":{"$ref":"#/components/schemas/StageMode"}},"additionalProperties":false,"description":"Summary representation of a bulk envelope stage."}},"components/schemas/BulkEnvelopeStageSummaryResponse":{"id":"components/schemas/BulkEnvelopeStageSummaryResponse","kind":"json-schema","title":"BulkEnvelopeStageSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1}},"additionalProperties":false,"description":"Stage summary within a bulk envelope response."}},"components/schemas/BulkEnvelopeSummary":{"id":"components/schemas/BulkEnvelopeSummary","kind":"json-schema","title":"BulkEnvelopeSummary","data":{"required":["createdAt","id","name","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The bulk envelope ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"The bulk envelope name.","example":"Bulk contract for onboarding"},"status":{"type":"string","description":"The current status of the bulk envelope.","example":"Draft"},"createdAt":{"type":"string","description":"When the bulk envelope was created.","format":"date-time","example":"2025-01-01T10:00:00Z"},"updatedAt":{"type":"string","description":"When the bulk envelope was last updated.","format":"date-time","example":"2025-01-01T10:00:00Z"},"sentAt":{"type":"string","description":"When the bulk envelope was sent.","format":"date-time","nullable":true,"example":"2025-01-02T12:00:00Z"}},"additionalProperties":false,"description":"Summary representation of a bulk envelope parent."}},"components/schemas/BusinessRoleDetails":{"id":"components/schemas/BusinessRoleDetails","kind":"json-schema","title":"BusinessRoleDetails","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The business role ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The business role name.","example":"Approver"},"description":{"type":"string","description":"The business role description.","nullable":true,"example":"Approves envelopes before completion."}},"additionalProperties":false,"description":"Detailed representation of a business role."}},"components/schemas/BusinessRoleListResponse":{"id":"components/schemas/BusinessRoleListResponse","kind":"json-schema","title":"BusinessRoleListResponse","data":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessRoleSummary"},"description":"The list of business roles."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"List of business roles."}},"components/schemas/BusinessRoleSummary":{"id":"components/schemas/BusinessRoleSummary","kind":"json-schema","title":"BusinessRoleSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The business role ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The business role name.","example":"Approver"},"description":{"type":"string","description":"The business role description.","nullable":true,"example":"Approves envelopes before completion."}},"additionalProperties":false,"description":"Summary representation of a business role."}},"components/schemas/BusinessRolesSortingKey":{"id":"components/schemas/BusinessRolesSortingKey","kind":"json-schema","title":"BusinessRolesSortingKey","data":{"enum":["Name"],"type":"string","description":"The available sorting keys for listing business roles."}},"components/schemas/CancelEnvelopeRequest":{"id":"components/schemas/CancelEnvelopeRequest","kind":"json-schema","title":"CancelEnvelopeRequest","data":{"type":"object","properties":{"reason":{"type":"string","description":"Free-text reason for the cancellation. Optional.","nullable":true,"example":"No longer needed"}},"additionalProperties":false,"description":"Optional request body for canceling an envelope."}},"components/schemas/CheckboxField":{"id":"components/schemas/CheckboxField","kind":"json-schema","title":"CheckboxField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"checked":{"type":"boolean","description":"Whether the checkbox is checked."},"value":{"type":"string","description":"The value of the checkbox.","nullable":true},"readOnly":{"type":"boolean","description":"Whether the field is read-only."},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Checkbox"],"type":"string","default":"Checkbox"}},"description":"A checkbox field.","example":{"fieldType":"Checkbox","checked":true,"value":"yes","readOnly":false,"required":false,"positionX":50,"positionY":300,"width":20,"height":20,"page":1,"id":"chk1"}}},"components/schemas/ClickToSignSignature":{"id":"components/schemas/ClickToSignSignature","kind":"json-schema","title":"ClickToSignSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["ClickToSignSignature"],"type":"string","default":"ClickToSignSignature"}},"additionalProperties":false,"description":"Click to sign signature configuration.","example":{"signatureType":"ClickToSignSignature"}}},"components/schemas/CloneEnvelopeResponse":{"id":"components/schemas/CloneEnvelopeResponse","kind":"json-schema","title":"CloneEnvelopeResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the cloned envelope.","format":"uuid","example":"00000000-0000-0000-0000-000000000050"}},"additionalProperties":false,"description":"Response after cloning an envelope."}},"components/schemas/CountryListResponse":{"id":"components/schemas/CountryListResponse","kind":"json-schema","title":"CountryListResponse","data":{"required":["countries"],"type":"object","properties":{"countries":{"type":"array","items":{"$ref":"#/components/schemas/CountryResponse"},"description":"The list of countries."}},"additionalProperties":false,"description":"List of available countries."}},"components/schemas/CountryResponse":{"id":"components/schemas/CountryResponse","kind":"json-schema","title":"CountryResponse","data":{"required":["code","name"],"type":"object","properties":{"code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"US"},"name":{"type":"string","description":"The display name of the country.","example":"United States"}},"additionalProperties":false,"description":"A country available for selection."}},"components/schemas/CreateAccessCode":{"id":"components/schemas/CreateAccessCode","kind":"json-schema","title":"CreateAccessCode","data":{"type":"object","properties":{"code":{"type":"string","description":"The access code.","nullable":true}},"additionalProperties":false,"description":"Access code configuration for creation."}},"components/schemas/CreateApplicationRoleRequest":{"id":"components/schemas/CreateApplicationRoleRequest","kind":"json-schema","title":"CreateApplicationRoleRequest","data":{"required":["name","permissions"],"type":"object","properties":{"name":{"type":"string","description":"The application role name.","example":"Contract Reviewer"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"},"description":"The entity/action permission pairs granted by the application role."},"description":{"type":"string","description":"The application role description.","nullable":true,"example":"Can read envelopes"}},"additionalProperties":false,"description":"Request body for creating an application role."}},"components/schemas/CreateApplicationRoleResponse":{"id":"components/schemas/CreateApplicationRoleResponse","kind":"json-schema","title":"CreateApplicationRoleResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created application role.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"Response after creating an application role."}},"components/schemas/CreateAuthenticationOneTimePassword":{"id":"components/schemas/CreateAuthenticationOneTimePassword","kind":"json-schema","title":"CreateAuthenticationOneTimePassword","data":{"required":["channel"],"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OneTimePasswordAuthenticationChannel"}},"additionalProperties":false,"description":"OTP authentication configuration for creation."}},"components/schemas/CreateBulkEnvelopeReminder":{"id":"components/schemas/CreateBulkEnvelopeReminder","kind":"json-schema","title":"CreateBulkEnvelopeReminder","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/CreateBulkEnvelopeRequest":{"id":"components/schemas/CreateBulkEnvelopeRequest","kind":"json-schema","title":"CreateBulkEnvelopeRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The bulk envelope name.","nullable":true,"example":"Bulk contract for Q1 campaign"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteCreateBulkEnvelopeExpiration"},{"$ref":"#/components/schemas/RelativeCreateBulkEnvelopeExpiration"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/CreateBulkEnvelopeReminder"},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the bulk envelope must use a qualified timestamp server.","nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the bulk envelope.","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the bulk envelope.","nullable":true,"example":"https://example.com/bulk-envelope-sent"}},"additionalProperties":false,"description":"Request body for creating a bulk envelope."}},"components/schemas/CreateBulkEnvelopeResponse":{"id":"components/schemas/CreateBulkEnvelopeResponse","kind":"json-schema","title":"CreateBulkEnvelopeResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created bulk envelope.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"}},"additionalProperties":false,"description":"Response after creating a bulk envelope."}},"components/schemas/CreateBulkEnvelopeStageAutomaticRecipientRequest":{"id":"components/schemas/CreateBulkEnvelopeStageAutomaticRecipientRequest","kind":"json-schema","title":"CreateBulkEnvelopeStageAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateBulkEnvelopeStageRecipientRequest"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"Signature profile name for the automatic recipient.","nullable":true,"example":"default-eseal-profile"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request to create an automatic recipient on a bulk envelope stage.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/CreateBulkEnvelopeStageRecipientRequest":{"id":"components/schemas/CreateBulkEnvelopeStageRecipientRequest","kind":"json-schema","title":"CreateBulkEnvelopeStageRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create bulk envelope stage recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreateBulkEnvelopeStageRecipientResponse":{"id":"components/schemas/CreateBulkEnvelopeStageRecipientResponse","kind":"json-schema","title":"CreateBulkEnvelopeStageRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created recipient.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"}},"additionalProperties":false,"description":"Response after creating a recipient on a bulk envelope stage."}},"components/schemas/CreateBulkEnvelopeStageRequest":{"id":"components/schemas/CreateBulkEnvelopeStageRequest","kind":"json-schema","title":"CreateBulkEnvelopeStageRequest","data":{"required":["mode","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/StageType"},"mode":{"$ref":"#/components/schemas/StageMode"},"name":{"type":"string","description":"The stage name. If omitted, the stage is created with an empty name.","nullable":true,"example":"Stage 1"},"requiredRecipientCompletions":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of recipients required to complete the stage. Ignored (may be omitted) when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bulk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CarbonCopy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required (greater than 0) otherwise."},"children":[]}]}]}],"format":"int32","nullable":true,"example":1}},"additionalProperties":false,"description":"Request body for creating a bulk envelope stage."}},"components/schemas/CreateBulkEnvelopeStageResponse":{"id":"components/schemas/CreateBulkEnvelopeStageResponse","kind":"json-schema","title":"CreateBulkEnvelopeStageResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created stage.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"}},"additionalProperties":false,"description":"Response after creating a bulk envelope stage."}},"components/schemas/CreateBulkEnvelopeStageStandardRecipientRequest":{"id":"components/schemas/CreateBulkEnvelopeStageStandardRecipientRequest","kind":"json-schema","title":"CreateBulkEnvelopeStageStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateBulkEnvelopeStageRecipientRequest"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/CreateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/CreateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for creating a Standard recipient on a bulk envelope stage."}},"components/schemas/CreateBusinessRoleRequest":{"id":"components/schemas/CreateBusinessRoleRequest","kind":"json-schema","title":"CreateBusinessRoleRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The business role name.","example":"Approver"},"description":{"type":"string","description":"The optional business role description.","nullable":true,"example":"Approves envelopes before completion."}},"additionalProperties":false,"description":"Request body for creating a business role."}},"components/schemas/CreateBusinessRoleResponse":{"id":"components/schemas/CreateBusinessRoleResponse","kind":"json-schema","title":"CreateBusinessRoleResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created business role.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"Response after creating a business role."}},"components/schemas/CreateDateDocumentMetadataRequest":{"id":"components/schemas/CreateDateDocumentMetadataRequest","kind":"json-schema","title":"CreateDateDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.DateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"DateType","name":"SignatureDate"}}},"components/schemas/CreateDateDocumentMetadataResponse":{"id":"components/schemas/CreateDateDocumentMetadataResponse","kind":"json-schema","title":"CreateDateDocumentMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.DateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"DateType","id":"3b5ef511-7aee-40c7-9041-c0efd2b797d8"}}},"components/schemas/CreateDisposableCertificate":{"id":"components/schemas/CreateDisposableCertificate","kind":"json-schema","title":"CreateDisposableCertificate","data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/CreateDisposableCertificateDocument"},"identification":{"$ref":"#/components/schemas/CreateDisposableCertificateIdentification"},"verificationPhoneNumber":{"type":"string","description":"The phone number for verification.","nullable":true}},"additionalProperties":false,"description":"Disposable certificate configuration for creation."}},"components/schemas/CreateDisposableCertificateDocument":{"id":"components/schemas/CreateDisposableCertificateDocument","kind":"json-schema","title":"CreateDisposableCertificateDocument","data":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","nullable":true},"number":{"type":"string","description":"The document number.","nullable":true},"serialNumber":{"type":"string","description":"The document serial number.","nullable":true},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true},"issuedBy":{"type":"string","description":"The issuing authority.","nullable":true},"issuedOn":{"type":"string","description":"When the document was issued.","format":"date-time","nullable":true},"expiresAt":{"type":"string","description":"When the document expires.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Identity document for disposable certificate during creation."}},"components/schemas/CreateDisposableCertificateIdentification":{"id":"components/schemas/CreateDisposableCertificateIdentification","kind":"json-schema","title":"CreateDisposableCertificateIdentification","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DisposableCertificateIdentificationType"},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true}},"additionalProperties":false,"description":"Identification method for disposable certificate during creation."}},"components/schemas/CreateDocumentClassRequest":{"id":"components/schemas/CreateDocumentClassRequest","kind":"json-schema","title":"CreateDocumentClassRequest","data":{"required":["description","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The document class name.","example":"Contract"},"description":{"type":"string","description":"The document class description.","example":"Documents related to contracts"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/DocumentClassMetadataReferenceRequest"},"description":"The metadata field references for this document class."}},"additionalProperties":false,"description":"Request body for creating a document class."}},"components/schemas/CreateDocumentClassResponse":{"id":"components/schemas/CreateDocumentClassResponse","kind":"json-schema","title":"CreateDocumentClassResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created document class.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"Response after creating a document class."}},"components/schemas/CreateDocumentMetadataRequest":{"id":"components/schemas/CreateDocumentMetadataRequest","kind":"json-schema","title":"CreateDocumentMetadataRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/CreateDocumentMetadataResponse":{"id":"components/schemas/CreateDocumentMetadataResponse","kind":"json-schema","title":"CreateDocumentMetadataResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/CreateEnvelopeAutomaticRecipientRequest":{"id":"components/schemas/CreateEnvelopeAutomaticRecipientRequest","kind":"json-schema","title":"CreateEnvelopeAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateEnvelopeRecipientRequest"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"Signature profile name for the automatic recipient.","nullable":true,"example":"default-eseal-profile"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request to create an automatic recipient in an envelope stage.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/CreateEnvelopeFromTemplateResponse":{"id":"components/schemas/CreateEnvelopeFromTemplateResponse","kind":"json-schema","title":"CreateEnvelopeFromTemplateResponse","data":{"required":["createdEnvelopeId"],"type":"object","properties":{"createdEnvelopeId":{"type":"string","description":"The ID of the created envelope.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating an envelope from a template."}},"components/schemas/CreateEnvelopeRecipientRequest":{"id":"components/schemas/CreateEnvelopeRecipientRequest","kind":"json-schema","title":"CreateEnvelopeRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create envelope recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreateEnvelopeRecipientResponse":{"id":"components/schemas/CreateEnvelopeRecipientResponse","kind":"json-schema","title":"CreateEnvelopeRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created recipient.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"}},"additionalProperties":false,"description":"Response after creating a recipient."}},"components/schemas/CreateEnvelopeReminder":{"id":"components/schemas/CreateEnvelopeReminder","kind":"json-schema","title":"CreateEnvelopeReminder","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/CreateEnvelopeRequest":{"id":"components/schemas/CreateEnvelopeRequest","kind":"json-schema","title":"CreateEnvelopeRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The envelope name.","nullable":true,"example":"Contract for Mario Rossi"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteCreateEnvelopeExpiration"},{"$ref":"#/components/schemas/RelativeCreateEnvelopeExpiration"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/CreateEnvelopeReminder"},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the envelope must use a qualified timestamp server.","nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the envelope.","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope.","nullable":true,"example":"https://example.com/envelope-sent"}},"additionalProperties":false,"description":"Request body for creating an envelope."}},"components/schemas/CreateEnvelopeResponse":{"id":"components/schemas/CreateEnvelopeResponse","kind":"json-schema","title":"CreateEnvelopeResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created envelope.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"}},"additionalProperties":false,"description":"Response after creating an envelope."}},"components/schemas/CreateEnvelopeStageRequest":{"id":"components/schemas/CreateEnvelopeStageRequest","kind":"json-schema","title":"CreateEnvelopeStageRequest","data":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/StageType"},"name":{"type":"string","description":"The stage name. If omitted, the stage is created with an empty name.","nullable":true,"example":"Stage 1"},"requiredRecipientCompletions":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of recipients required to complete the stage. Ignored (may be omitted) when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CarbonCopy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required (greater than 0) for every other stage type."},"children":[]}]}]}],"format":"int32","nullable":true,"example":1}},"additionalProperties":false,"description":"Request body for creating a stage."}},"components/schemas/CreateEnvelopeStageResponse":{"id":"components/schemas/CreateEnvelopeStageResponse","kind":"json-schema","title":"CreateEnvelopeStageResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created stage.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"}},"additionalProperties":false,"description":"Response after creating a stage."}},"components/schemas/CreateEnvelopeStandardRecipientRequest":{"id":"components/schemas/CreateEnvelopeStandardRecipientRequest","kind":"json-schema","title":"CreateEnvelopeStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateEnvelopeRecipientRequest"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/CreateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/CreateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for creating a Standard recipient."}},"components/schemas/CreateEnvelopeWebhookRequest":{"id":"components/schemas/CreateEnvelopeWebhookRequest","kind":"json-schema","title":"CreateEnvelopeWebhookRequest","data":{"required":["event","url"],"type":"object","properties":{"url":{"type":"string","description":"The URL receiving the webhook calls (max 2048 characters).","example":"https://example.com/hooks/envelope"},"event":{"$ref":"#/components/schemas/WebhookEventType"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationRequest"}},"additionalProperties":false,"description":"Request body for creating an envelope webhook."}},"components/schemas/CreateEnvelopeWebhookResponse":{"id":"components/schemas/CreateEnvelopeWebhookResponse","kind":"json-schema","title":"CreateEnvelopeWebhookResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created webhook.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating an envelope webhook."}},"components/schemas/CreateListOptionDocumentMetadataRequest":{"id":"components/schemas/CreateListOptionDocumentMetadataRequest","kind":"json-schema","title":"CreateListOptionDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataRequest"},{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadataOptionRequest"},"description":"The predefined selectable options. Must be non-empty.","nullable":true},"parentId":{"type":"string","description":"The ID of an existing metadata field of type ListOptionType to set as this field's parent, or omit for no parent. Must not be this field itself or one of its children.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.ListOptionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"options":[{"value":"Invoice","parentId":"a36472ee-254d-4668-a9c8-18149720e4b9"},{"value":"NDA","parentId":"ec13bf6f-eab9-4eb9-84a0-dbfc30935ff7"}],"parentId":"8c1e9998-4746-4d94-8eaf-fb1463c43ae6","type":"ListOptionType","name":"ContractType"}}},"components/schemas/CreateListOptionDocumentMetadataResponse":{"id":"components/schemas/CreateListOptionDocumentMetadataResponse","kind":"json-schema","title":"CreateListOptionDocumentMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataResponse"},{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadataOptionItem"},"description":"The predefined selectable options.","nullable":true},"parentId":{"type":"string","description":"The ID of the parent metadata field this field depends on, when defined.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.ListOptionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"options":[{"id":"db9b8856-5cf2-406e-a0b4-e5f56d25a4e3","value":"Invoice","parentId":"67c7ed8c-c16b-4887-8f2a-eb1c2c45dbef"},{"id":"d0e07435-7edd-481a-933b-c983e522991d","value":"NDA"}],"parentId":"61d4c172-b9b1-461e-8f44-53912b9a8d20","type":"ListOptionType","id":"c97a4e58-f410-4d08-8c80-e35cbe172594"}}},"components/schemas/CreateNumberDocumentMetadataRequest":{"id":"components/schemas/CreateNumberDocumentMetadataRequest","kind":"json-schema","title":"CreateNumberDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.NumberType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"NumberType","name":"TotalAmount"}}},"components/schemas/CreateNumberDocumentMetadataResponse":{"id":"components/schemas/CreateNumberDocumentMetadataResponse","kind":"json-schema","title":"CreateNumberDocumentMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.NumberType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"NumberType","id":"b4483424-9dad-444f-9eaa-8931f53e39fd"}}},"components/schemas/CreateOAuthAuthentication":{"id":"components/schemas/CreateOAuthAuthentication","kind":"json-schema","title":"CreateOAuthAuthentication","data":{"required":["id"],"type":"object","properties":{"providerName":{"type":"string","description":"The OAuth provider name.","nullable":true},"id":{"type":"string","description":"The identifier of the OAuth provider.","format":"uuid"}},"additionalProperties":false,"description":"OAuth authentication configuration for creation."}},"components/schemas/CreateOrganizationWebhookRequest":{"id":"components/schemas/CreateOrganizationWebhookRequest","kind":"json-schema","title":"CreateOrganizationWebhookRequest","data":{"required":["event","url"],"type":"object","properties":{"url":{"type":"string","description":"The URL receiving the webhook calls (max 2048 characters).","example":"https://example.com/hooks/organization"},"event":{"$ref":"#/components/schemas/WebhookEventType"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationRequest"}},"additionalProperties":false,"description":"Request body for creating an organization webhook."}},"components/schemas/CreateOrganizationWebhookResponse":{"id":"components/schemas/CreateOrganizationWebhookResponse","kind":"json-schema","title":"CreateOrganizationWebhookResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created webhook.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating an organization webhook."}},"components/schemas/CreateOtpSignature":{"id":"components/schemas/CreateOtpSignature","kind":"json-schema","title":"CreateOtpSignature","data":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OtpDeliveryChannel"}},"additionalProperties":false,"description":"OTP signature configuration for creation."}},"components/schemas/CreatePolicyRequest":{"id":"components/schemas/CreatePolicyRequest","kind":"json-schema","title":"CreatePolicyRequest","data":{"required":["actions","conditions","isActive","name"],"type":"object","properties":{"name":{"type":"string","description":"The policy name.","example":"Standard signing policy"},"isActive":{"type":"boolean","description":"Whether the policy is active.","example":true},"description":{"type":"string","description":"The policy description.","nullable":true,"example":"Policy applied to all standard signing envelopes"},"documentClassId":{"type":"string","description":"The document class this policy applies to, when set.","format":"uuid","nullable":true},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/PolicyConditionRequest"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The policy's conditions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must start at 1, be unique, and contiguous within the list."},"children":[]}]}]}]},"actions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AddEnvelopeStageConfigurationActionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single action within a policy request. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The policy's actions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must start at 1, be unique, and contiguous within the list."},"children":[]}]}]}]}},"additionalProperties":false,"description":"Request body for creating a policy."}},"components/schemas/CreateRecipientAuthentication":{"id":"components/schemas/CreateRecipientAuthentication","kind":"json-schema","title":"CreateRecipientAuthentication","data":{"type":"object","properties":{"accessCode":{"$ref":"#/components/schemas/CreateAccessCode"},"oneTimePassword":{"$ref":"#/components/schemas/CreateAuthenticationOneTimePassword"},"oAuthAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/CreateOAuthAuthentication"},"description":"OAuth authentications.","nullable":true}},"additionalProperties":false,"description":"Recipient authentication configuration for creation."}},"components/schemas/CreateRecipientSignatureData":{"id":"components/schemas/CreateRecipientSignatureData","kind":"json-schema","title":"CreateRecipientSignatureData","data":{"type":"object","properties":{"disposableCertificate":{"$ref":"#/components/schemas/CreateDisposableCertificate"},"remoteCertificate":{"$ref":"#/components/schemas/CreateRemoteCertificateDto"},"otpSignature":{"$ref":"#/components/schemas/CreateOtpSignature"},"signingPlugins":{"$ref":"#/components/schemas/CreateSigningPlugins"}},"additionalProperties":false,"description":"Signature configuration for a recipient during creation."}},"components/schemas/CreateRemoteCertificateDto":{"id":"components/schemas/CreateRemoteCertificateDto","kind":"json-schema","title":"CreateRemoteCertificateDto","data":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID.","nullable":true},"deviceId":{"type":"string","description":"The device ID.","nullable":true}},"additionalProperties":false,"description":"Remote certificate configuration for creation."}},"components/schemas/CreateSignatureLayoutResponse":{"id":"components/schemas/CreateSignatureLayoutResponse","kind":"json-schema","title":"CreateSignatureLayoutResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The identifier of the created signature layout.","format":"uuid"}},"additionalProperties":false,"description":"Response returned after creating a signature layout."}},"components/schemas/CreateSigningPlugin":{"id":"components/schemas/CreateSigningPlugin","kind":"json-schema","title":"CreateSigningPlugin","data":{"type":"object","properties":{"pluginId":{"type":"string","description":"The plugin ID.","nullable":true},"settings":{"type":"array","items":{"$ref":"#/components/schemas/CreateSigningPluginSetting"},"description":"The plugin settings.","nullable":true}},"additionalProperties":false,"description":"A signing plugin for creation."}},"components/schemas/CreateSigningPluginSetting":{"id":"components/schemas/CreateSigningPluginSetting","kind":"json-schema","title":"CreateSigningPluginSetting","data":{"type":"object","properties":{"key":{"type":"string","description":"The setting key.","nullable":true},"value":{"type":"string","description":"The setting value.","nullable":true}},"additionalProperties":false,"description":"A signing plugin setting for creation."}},"components/schemas/CreateSigningPlugins":{"id":"components/schemas/CreateSigningPlugins","kind":"json-schema","title":"CreateSigningPlugins","data":{"type":"object","properties":{"plugins":{"type":"array","items":{"$ref":"#/components/schemas/CreateSigningPlugin"},"description":"The list of signing plugins.","nullable":true}},"additionalProperties":false,"description":"Signing plugins configuration for creation."}},"components/schemas/CreateStringDocumentMetadataRequest":{"id":"components/schemas/CreateStringDocumentMetadataRequest","kind":"json-schema","title":"CreateStringDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.StringType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"StringType","name":"ContractNumber"}}},"components/schemas/CreateStringDocumentMetadataResponse":{"id":"components/schemas/CreateStringDocumentMetadataResponse","kind":"json-schema","title":"CreateStringDocumentMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateDocumentMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.StringType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"StringType","id":"745322f7-2ef0-46ed-b928-b999f00d679e"}}},"components/schemas/CreateTemplateAutomaticRecipientRequest":{"id":"components/schemas/CreateTemplateAutomaticRecipientRequest","kind":"json-schema","title":"CreateTemplateAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateTemplateRecipientRequest"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request body for creating an Automatic recipient.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/CreateTemplateRecipientRequest":{"id":"components/schemas/CreateTemplateRecipientRequest","kind":"json-schema","title":"CreateTemplateRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create template recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreateTemplateRecipientResponse":{"id":"components/schemas/CreateTemplateRecipientResponse","kind":"json-schema","title":"CreateTemplateRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created recipient.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating a recipient."}},"components/schemas/CreateTemplateReminder":{"id":"components/schemas/CreateTemplateReminder","kind":"json-schema","title":"CreateTemplateReminder","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/CreateTemplateRequest":{"id":"components/schemas/CreateTemplateRequest","kind":"json-schema","title":"CreateTemplateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The template name.","nullable":true,"example":"Standard NDA template"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteCreateTemplateExpiration"},{"$ref":"#/components/schemas/RelativeCreateTemplateExpiration"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/CreateTemplateReminder"},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the template must use a qualified timestamp server.","nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the template.","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope.","nullable":true,"example":"https://example.com/envelope-sent"}},"additionalProperties":false,"description":"Request body for creating a template."}},"components/schemas/CreateTemplateResponse":{"id":"components/schemas/CreateTemplateResponse","kind":"json-schema","title":"CreateTemplateResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created template.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating a template."}},"components/schemas/CreateTemplateStageRequest":{"id":"components/schemas/CreateTemplateStageRequest","kind":"json-schema","title":"CreateTemplateStageRequest","data":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/StageType"},"name":{"type":"string","description":"The stage name. If omitted, the stage is created with an empty name.","nullable":true,"example":"Stage 1"},"requiredRecipientCompletions":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of recipients required to complete the stage. Ignored (may be omitted) when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CarbonCopy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required (greater than 0) for every other stage type."},"children":[]}]}]}],"format":"int32","nullable":true,"example":1}},"additionalProperties":false,"description":"Request body for creating a stage."}},"components/schemas/CreateTemplateStageResponse":{"id":"components/schemas/CreateTemplateStageResponse","kind":"json-schema","title":"CreateTemplateStageResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created stage.","format":"uuid"}},"additionalProperties":false,"description":"Response after creating a stage."}},"components/schemas/CreateTemplateStandardRecipientRequest":{"id":"components/schemas/CreateTemplateStandardRecipientRequest","kind":"json-schema","title":"CreateTemplateStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CreateTemplateRecipientRequest"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true},"surname":{"type":"string","description":"The recipient's last name.","nullable":true},"email":{"type":"string","description":"The recipient's email address.","nullable":true},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/CreateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/CreateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for creating a Standard recipient."}},"components/schemas/CreateUserGroupContactRequest":{"id":"components/schemas/CreateUserGroupContactRequest","kind":"json-schema","title":"CreateUserGroupContactRequest","data":{"type":"object","properties":{"givenName":{"type":"string","description":"The contact's first name.","nullable":true,"example":"John"},"surname":{"type":"string","description":"The contact's last name.","nullable":true,"example":"Smith"},"email":{"type":"string","description":"The contact's email address.","nullable":true,"example":"john.smith@example.com"},"phoneNumber":{"type":"string","description":"The contact's phone number.","nullable":true,"example":"+44 20 7946 0958"},"language":{"type":"string","description":"The contact's culture ISO code.","nullable":true,"example":"en"}},"additionalProperties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a contact in a user group. The values of the group's custom fields are sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional properties next to the standard fields, keyed by custom field name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Tax code\": \"AB123456C\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"components/schemas/CreateUserGroupContactResponse":{"id":"components/schemas/CreateUserGroupContactResponse","kind":"json-schema","title":"CreateUserGroupContactResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created contact.","format":"uuid","example":"e201ace1-7752-4a33-a9b3-2a46902e8de3"}},"additionalProperties":false,"description":"Response after creating a contact in a user group."}},"components/schemas/CreateUserGroupRequest":{"id":"components/schemas/CreateUserGroupRequest","kind":"json-schema","title":"CreateUserGroupRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The user group name.","example":"Sales Team"}},"additionalProperties":false,"description":"Request body for creating a user group."}},"components/schemas/CreateUserGroupResponse":{"id":"components/schemas/CreateUserGroupResponse","kind":"json-schema","title":"CreateUserGroupResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created user group.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"Response after creating a user group."}},"components/schemas/CreateUserRequest":{"id":"components/schemas/CreateUserRequest","kind":"json-schema","title":"CreateUserRequest","data":{"required":["email","givenName","regionalSettings","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Mario"},"surname":{"type":"string","description":"The user's last name.","example":"Rossi"},"email":{"type":"string","description":"The user's email address.","example":"mario.rossi@example.com"},"regionalSettings":{"$ref":"#/components/schemas/UserRegionalSettingsRequest"},"phoneNumber":{"type":"string","description":"The user's optional phone number.","nullable":true,"example":"+39021234567"}},"additionalProperties":false,"description":"Request body for creating a user within an organization."}},"components/schemas/CreateUserResponse":{"id":"components/schemas/CreateUserResponse","kind":"json-schema","title":"CreateUserResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created user.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},"additionalProperties":false,"description":"Response after creating a user within an organization."}},"components/schemas/CreateWebhookSubscriptionRequest":{"id":"components/schemas/CreateWebhookSubscriptionRequest","kind":"json-schema","title":"CreateWebhookSubscriptionRequest","data":{"required":["url"],"type":"object","properties":{"url":{"type":"string","description":"The HTTPS URL to receive webhook events."},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationRequest"}},"additionalProperties":false,"description":"Request body for creating a webhook subscription."}},"components/schemas/CreatedPolicyResponse":{"id":"components/schemas/CreatedPolicyResponse","kind":"json-schema","title":"CreatedPolicyResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the created policy.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"Response after creating a policy."}},"components/schemas/DateAnnotationValueFormat":{"id":"components/schemas/DateAnnotationValueFormat","kind":"json-schema","title":"DateAnnotationValueFormat","data":{"required":["annotationType","format"],"type":"object","properties":{"annotationType":{"enum":["Date"],"type":"string","default":"Date"},"format":{"$ref":"#/components/schemas/DateFormat"}},"additionalProperties":false,"description":"Date annotation value format."}},"components/schemas/DateDocumentClassMetadataResponse":{"id":"components/schemas/DateDocumentClassMetadataResponse","kind":"json-schema","title":"DateDocumentClassMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentClassMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":"A document class metadata field carrying a date value.","example":{"type":"DateType","id":"9f1da3c0-6c64-467a-a4ee-e933e26ab15c","name":"SignatureDate","required":false,"sortOrder":3}}},"components/schemas/DateDocumentMetadataItem":{"id":"components/schemas/DateDocumentMetadataItem","kind":"json-schema","title":"DateDocumentMetadataItem","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentMetadataItem"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization-level document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.DateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"DateType","id":"610e4bea-5bdf-40b9-873f-88975f4779fd","name":"SignatureDate"}}},"components/schemas/DateFileMetadataValueResponse":{"id":"components/schemas/DateFileMetadataValueResponse","kind":"json-schema","title":"DateFileMetadataValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/FileMetadataValueResponse"},{"type":"object","properties":{"value":{"type":"string","description":"The date value, or null if not set.","format":"date","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":"An ISO-8601 date metadata value of a file.","example":{"value":"2026-05-20","type":"DateType","id":"a0826875-fcde-49d9-9ae1-9b6b8ba72cd9","name":"SignDate"}}},"components/schemas/DateFormat":{"id":"components/schemas/DateFormat","kind":"json-schema","title":"DateFormat","data":{"enum":["dd.MM.yy","dd.MM.yyyy"],"type":"string","description":"Available date display formats for a date text input."}},"components/schemas/DateInputConfig":{"id":"components/schemas/DateInputConfig","kind":"json-schema","title":"DateInputConfig","data":{"required":["format","textInputType"],"type":"object","properties":{"textInputType":{"enum":["DateType"],"type":"string","default":"DateType"},"value":{"type":"string","description":"The date value.","format":"date","nullable":true},"format":{"$ref":"#/components/schemas/DateFormat"},"minValue":{"type":"string","description":"The minimum allowed date.","format":"date","nullable":true},"maxValue":{"type":"string","description":"The maximum allowed date.","format":"date","nullable":true}},"additionalProperties":false,"description":"Configuration for a date text input.","example":{"textInputType":"DateType","value":"2025-12-31","format":"dd.MM.yyyy","minValue":"2025-01-01","maxValue":"2026-12-31"}}},"components/schemas/DateMetadataValueRequest":{"id":"components/schemas/DateMetadataValueRequest","kind":"json-schema","title":"DateMetadataValueRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/MetadataValueRequest"},{"type":"object","properties":{"value":{"type":"string","description":"The date value.","format":"date"}},"additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":"A metadata value carrying an ISO-8601 date payload."}},"components/schemas/DatePolicyConditionMetadataRequest":{"id":"components/schemas/DatePolicyConditionMetadataRequest","kind":"json-schema","title":"DatePolicyConditionMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataRequest"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison date value.","format":"date"}},"additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":"A policy condition's comparison value for a date-type metadata field."}},"components/schemas/DatePolicyConditionValueResponse":{"id":"components/schemas/DatePolicyConditionValueResponse","kind":"json-schema","title":"DatePolicyConditionValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataResponse"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison date value.","format":"date"}},"additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":"A policy condition's comparison value for a date-type metadata field."}},"components/schemas/DateTimeFormat":{"id":"components/schemas/DateTimeFormat","kind":"json-schema","title":"DateTimeFormat","data":{"enum":["dd/MM/yyyy | HH:mm","dd/MM/yy | HH:mm","dd-MMM-yy | HH:mm","dd-MMM-yyyy | HH:mm","dd MMMM yyyy | HH:mm","yyyy-MM-dd | HH:mm","yyyy-MMM-dd | HH:mm","yyyy MMMM dd | HH:mm","MMM d, yyyy | HH:mm","MMM-dd-yyyy | HH:mm","MMMM d, yyyy | HH:mm","MM/d/yyyy | HH:mm","dd.MM.yyyy | HH:mm","dd. MMMM yyyy | HH:mm","dd.MM.yy | HH:mm"],"type":"string","description":"Available date and time format patterns for regional settings."}},"components/schemas/DateTimeFormatListResponse":{"id":"components/schemas/DateTimeFormatListResponse","kind":"json-schema","title":"DateTimeFormatListResponse","data":{"required":["dateTimeFormats"],"type":"object","properties":{"dateTimeFormats":{"type":"array","items":{"$ref":"#/components/schemas/DateTimeFormatResponse"},"description":"The list of date/time formats."}},"additionalProperties":false,"description":"List of available date/time formats."}},"components/schemas/DateTimeFormatResponse":{"id":"components/schemas/DateTimeFormatResponse","kind":"json-schema","title":"DateTimeFormatResponse","data":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"The date and time format pattern.","example":"dd/MM/yyyy | HH:mm"}},"additionalProperties":false,"description":"A date/time format available for selection."}},"components/schemas/DecimalSeparator":{"id":"components/schemas/DecimalSeparator","kind":"json-schema","title":"DecimalSeparator","data":{"enum":["Comma","Point","Apostrophe","None"],"type":"string","description":"The decimal separator used by a number text input."}},"components/schemas/DefaultSignatureType":{"id":"components/schemas/DefaultSignatureType","kind":"json-schema","title":"DefaultSignatureType","data":{"enum":["ClickToSign","DrawToSign","TypeToSign","RemoteCertificate","Biometric","LocalCertificate","DisposableCertificate","OneTimePassword"],"type":"string","description":"The default signature types supported by the settings/signature endpoint."}},"components/schemas/DefaultSignatureTypeOptional":{"id":"components/schemas/DefaultSignatureTypeOptional","kind":"json-schema","title":"DefaultSignatureTypeOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/DefaultSignatureType"}},"additionalProperties":false}},"components/schemas/DisposableCertificate":{"id":"components/schemas/DisposableCertificate","kind":"json-schema","title":"DisposableCertificate","data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/DisposableCertificateDocument"},"identification":{"$ref":"#/components/schemas/DisposableCertificateIdentification"},"verificationPhoneNumber":{"type":"string","description":"The phone number for verification.","nullable":true}},"additionalProperties":false,"description":"Disposable certificate configuration."}},"components/schemas/DisposableCertificateDocument":{"id":"components/schemas/DisposableCertificateDocument","kind":"json-schema","title":"DisposableCertificateDocument","data":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","nullable":true},"number":{"type":"string","description":"The document number.","nullable":true},"serialNumber":{"type":"string","description":"The document serial number.","nullable":true},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true},"issuedBy":{"type":"string","description":"The issuing authority.","nullable":true},"issuedOn":{"type":"string","description":"When the document was issued.","format":"date-time","nullable":true},"expiresAt":{"type":"string","description":"When the document expires.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Identity document for disposable certificate."}},"components/schemas/DisposableCertificateIdentification":{"id":"components/schemas/DisposableCertificateIdentification","kind":"json-schema","title":"DisposableCertificateIdentification","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DisposableCertificateIdentificationType"},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true}},"additionalProperties":false,"description":"Identification method for disposable certificate."}},"components/schemas/DisposableCertificateIdentificationType":{"id":"components/schemas/DisposableCertificateIdentificationType","kind":"json-schema","title":"DisposableCertificateIdentificationType","data":{"enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","ResidencePermitTemp","EmbassyDocument","Am"],"type":"string","description":"Identification document type for a disposable certificate signature."}},"components/schemas/DisposableCertificateSignature":{"id":"components/schemas/DisposableCertificateSignature","kind":"json-schema","title":"DisposableCertificateSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["DisposableCertificateSignature"],"type":"string","default":"DisposableCertificateSignature"}},"additionalProperties":false,"description":"Disposable certificate signature configuration.","example":{"signatureType":"DisposableCertificateSignature"}}},"components/schemas/DisposableCertificateType":{"id":"components/schemas/DisposableCertificateType","kind":"json-schema","title":"DisposableCertificateType","data":{"enum":["Disposable","Disposable30Days"],"type":"string","description":"The disposable certificate types supported by an organization."}},"components/schemas/DisposableCertificateTypeOptional":{"id":"components/schemas/DisposableCertificateTypeOptional","kind":"json-schema","title":"DisposableCertificateTypeOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/DisposableCertificateType"}},"additionalProperties":false}},"components/schemas/DocumentClassListResponse":{"id":"components/schemas/DocumentClassListResponse","kind":"json-schema","title":"DocumentClassListResponse","data":{"required":["documentClasses","pagination"],"type":"object","properties":{"documentClasses":{"type":"array","items":{"$ref":"#/components/schemas/DocumentClassSummary"},"description":"The list of document classes."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of document classes."}},"components/schemas/DocumentClassMetadataReferenceRequest":{"id":"components/schemas/DocumentClassMetadataReferenceRequest","kind":"json-schema","title":"DocumentClassMetadataReferenceRequest","data":{"required":["id","required","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The referenced metadata field ID.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"},"sortOrder":{"type":"integer","description":"The display order of the metadata field within the document class.","format":"int32","example":1},"required":{"type":"boolean","description":"Whether the field is required for this document class.","example":true}},"additionalProperties":false,"description":"A reference to an existing organization metadata field, attached to a document class."}},"components/schemas/DocumentClassMetadataResponse":{"id":"components/schemas/DocumentClassMetadataResponse","kind":"json-schema","title":"DocumentClassMetadataResponse","data":{"required":["id","name","required","sortOrder"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"required":{"type":"boolean"},"sortOrder":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A document class metadata field, as returned by the document class GET response. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/DocumentClassResponse":{"id":"components/schemas/DocumentClassResponse","kind":"json-schema","title":"DocumentClassResponse","data":{"required":["description","id","metadata","name"],"type":"object","properties":{"id":{"type":"string","description":"The document class ID.","format":"uuid"},"name":{"type":"string","description":"The document class name."},"description":{"type":"string","description":"The document class description."},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringDocumentClassMetadataResponse"},{"$ref":"#/components/schemas/NumberDocumentClassMetadataResponse"},{"$ref":"#/components/schemas/DateDocumentClassMetadataResponse"},{"$ref":"#/components/schemas/ListOptionDocumentClassMetadataResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A document class metadata field, as returned by the document class GET response. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"description":"The list of full metadata field data."}},"additionalProperties":false,"description":"Response model for a single document class."}},"components/schemas/DocumentClassSummary":{"id":"components/schemas/DocumentClassSummary","kind":"json-schema","title":"DocumentClassSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The document class ID.","format":"uuid","example":"6f2ed3d2-0617-4be4-9445-7e6a4090b260"},"name":{"type":"string","description":"The document class name.","example":"Contract"}},"additionalProperties":false,"description":"Summary representation of a document class."}},"components/schemas/DocumentMetadataItem":{"id":"components/schemas/DocumentMetadataItem","kind":"json-schema","title":"DocumentMetadataItem","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a document metadata field at the organization level. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/DocumentMetadataListResult":{"id":"components/schemas/DocumentMetadataListResult","kind":"json-schema","title":"DocumentMetadataListResult","data":{"required":["documentMetadata","pagination"],"type":"object","properties":{"documentMetadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringDocumentMetadataItem"},{"$ref":"#/components/schemas/NumberDocumentMetadataItem"},{"$ref":"#/components/schemas/DateDocumentMetadataItem"},{"$ref":"#/components/schemas/ListOptionDocumentMetadataItem"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a document metadata field at the organization level. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"description":"The metadata fields on the current page."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of document metadata fields."}},"components/schemas/DocumentMetadataOptionItem":{"id":"components/schemas/DocumentMetadataOptionItem","kind":"json-schema","title":"DocumentMetadataOptionItem","data":{"required":["id","value"],"type":"object","properties":{"id":{"type":"string","description":"The option ID.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"},"value":{"type":"string","description":"The option value.","example":"Invoice"},"parentId":{"type":"string","description":"The ID of the parent metadata field's option value this option is tied to, when the field has a parent.","format":"uuid","nullable":true,"example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"A predefined selectable option value for a list-option document metadata field, as returned by the API."}},"components/schemas/DocumentMetadataOptionRequest":{"id":"components/schemas/DocumentMetadataOptionRequest","kind":"json-schema","title":"DocumentMetadataOptionRequest","data":{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The option value.","example":"Invoice"},"parentId":{"type":"string","description":"The ID of the parent metadata field's option value this option is tied to, when the field has a parent.","format":"uuid","nullable":true,"example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"A predefined selectable option value for a list-option document metadata field."}},"components/schemas/DrawToSignSignature":{"id":"components/schemas/DrawToSignSignature","kind":"json-schema","title":"DrawToSignSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["DrawToSignSignature"],"type":"string","default":"DrawToSignSignature"}},"additionalProperties":false,"description":"Draw to sign signature configuration.","example":{"signatureType":"DrawToSignSignature"}}},"components/schemas/DropDownField":{"id":"components/schemas/DropDownField","kind":"json-schema","title":"DropDownField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"font":{"$ref":"#/components/schemas/FontStyle"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"},"description":"The list of options.","nullable":true},"readOnly":{"type":"boolean","description":"Whether the field is read-only."},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["DropDown"],"type":"string","default":"DropDown"}},"description":"A drop-down field.","example":{"fieldType":"DropDown","font":{"size":12,"name":"Helvetica","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"readOnly":false,"required":false,"positionX":50,"positionY":400,"width":150,"height":30,"page":1,"id":"dd1"}}},"components/schemas/DynamicPolicyRecipientSourceRequest":{"id":"components/schemas/DynamicPolicyRecipientSourceRequest","kind":"json-schema","title":"DynamicPolicyRecipientSourceRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyRecipientSourceRequest"},{"type":"object","properties":{"userGroupId":{"type":"string","description":"The user group ID recipients are resolved from, when set.","format":"uuid","nullable":true},"businessRoleId":{"type":"string","description":"The business role ID recipients are resolved from, when set.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Dynamic"],"type":"string","default":"Dynamic"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipients are resolved dynamically from a user group or business role. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessRoleId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]}},"components/schemas/DynamicPolicyRecipientSourceResponse":{"id":"components/schemas/DynamicPolicyRecipientSourceResponse","kind":"json-schema","title":"DynamicPolicyRecipientSourceResponse","data":{"required":["type"],"type":"object","properties":{"userGroupId":{"type":"string","description":"The user group ID recipients are resolved from, when set.","format":"uuid","nullable":true},"businessRoleId":{"type":"string","description":"The business role ID recipients are resolved from, when set.","format":"uuid","nullable":true},"type":{"enum":["Dynamic"],"type":"string","default":"Dynamic"}},"additionalProperties":false,"description":"A policy action's recipient source resolved dynamically from a user group or business role."}},"components/schemas/ElementSource":{"id":"components/schemas/ElementSource","kind":"json-schema","title":"ElementSource","data":{"enum":["File","UserDefined"],"type":"string","description":"The origin of a field on a file."}},"components/schemas/EligibleParentResponse":{"id":"components/schemas/EligibleParentResponse","kind":"json-schema","title":"EligibleParentResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The eligible parent metadata field ID.","format":"uuid","example":"048f2e2c-0f48-498b-953d-02d414c60baf"}},"additionalProperties":false,"description":"A document metadata field eligible to be set as the parent of another field."}},"components/schemas/EligibleParentsResponse":{"id":"components/schemas/EligibleParentsResponse","kind":"json-schema","title":"EligibleParentsResponse","data":{"required":["eligibleParents"],"type":"object","properties":{"eligibleParents":{"type":"array","items":{"$ref":"#/components/schemas/EligibleParentResponse"},"description":"The list of eligible parent metadata fields."}},"additionalProperties":false,"description":"The document metadata fields eligible to be set as the parent of a given field."}},"components/schemas/EmailAnnotationValueFormat":{"id":"components/schemas/EmailAnnotationValueFormat","kind":"json-schema","title":"EmailAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["Email"],"type":"string","default":"Email"}},"additionalProperties":false,"description":"Email annotation value format."}},"components/schemas/EnvelopeArtifactListResponse":{"id":"components/schemas/EnvelopeArtifactListResponse","kind":"json-schema","title":"EnvelopeArtifactListResponse","data":{"required":["artifacts"],"type":"object","properties":{"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeArtifactResponse"},"description":"The list of artifacts."}},"additionalProperties":false,"description":"List of envelope artifacts."}},"components/schemas/EnvelopeArtifactResponse":{"id":"components/schemas/EnvelopeArtifactResponse","kind":"json-schema","title":"EnvelopeArtifactResponse","data":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string","description":"The artifact ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000030"},"name":{"type":"string","description":"The artifact name.","example":"contract-signed.pdf"},"type":{"$ref":"#/components/schemas/EnvelopeArtifactType"}},"additionalProperties":false,"description":"Representation of an envelope artifact."}},"components/schemas/EnvelopeArtifactType":{"id":"components/schemas/EnvelopeArtifactType","kind":"json-schema","title":"EnvelopeArtifactType","data":{"enum":["CompletedFile","AuditTrail","CompletedFiles"],"type":"string","description":"The types of artifacts generated during signing."}},"components/schemas/EnvelopeAutomaticRecipientResponse":{"id":"components/schemas/EnvelopeAutomaticRecipientResponse","kind":"json-schema","title":"EnvelopeAutomaticRecipientResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/EnvelopeRecipientResponse"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile used for automatic signing.","nullable":true,"example":"default-eseal-profile"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Detailed representation of an Automatic signer recipient.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","id":"00000000-0000-0000-0000-000000000100","languageCode":"en-US"}}},"components/schemas/EnvelopeEventActorResponse":{"id":"components/schemas/EnvelopeEventActorResponse","kind":"json-schema","title":"EnvelopeEventActorResponse","data":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email of the actor.","example":"owner@example.com"}},"additionalProperties":false,"description":"The actor of an event."}},"components/schemas/EnvelopeEventListResponse":{"id":"components/schemas/EnvelopeEventListResponse","kind":"json-schema","title":"EnvelopeEventListResponse","data":{"required":["events"],"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeEventResponse"},"description":"The list of events."}},"additionalProperties":false,"description":"List of envelope events."}},"components/schemas/EnvelopeEventResponse":{"id":"components/schemas/EnvelopeEventResponse","kind":"json-schema","title":"EnvelopeEventResponse","data":{"required":["id","occurredAt","type"],"type":"object","properties":{"id":{"type":"string","description":"The event ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000040"},"type":{"type":"string","description":"The event type.","example":"EnvelopeSent"},"actor":{"$ref":"#/components/schemas/EnvelopeEventActorResponse"},"occurredAt":{"type":"string","description":"When the event occurred.","format":"date-time","example":"2025-01-02T12:00:00Z"}},"additionalProperties":false,"description":"Representation of an envelope event."}},"components/schemas/EnvelopeFileDetailResponse":{"id":"components/schemas/EnvelopeFileDetailResponse","kind":"json-schema","title":"EnvelopeFileDetailResponse","data":{"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/EnvelopeFileDocumentClassResponse"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file, or null if not set.","nullable":true}},"additionalProperties":false,"description":"Response containing details of an envelope file."}},"components/schemas/EnvelopeFileDocumentClassResponse":{"id":"components/schemas/EnvelopeFileDocumentClassResponse","kind":"json-schema","title":"EnvelopeFileDocumentClassResponse","data":{"required":["id","metadata"],"type":"object","properties":{"id":{"type":"string","description":"The assigned document class ID.","format":"uuid"},"name":{"type":"string","description":"The document class name, or null if none is assigned.","nullable":true},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringFileMetadataValueResponse"},{"$ref":"#/components/schemas/NumberFileMetadataValueResponse"},{"$ref":"#/components/schemas/DateFileMetadataValueResponse"},{"$ref":"#/components/schemas/ListOptionFileMetadataValueResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value of a file. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata field values for this file."}},"additionalProperties":false,"description":"Response containing the document class assigned to an envelope file."}},"components/schemas/EnvelopeFileListResponse":{"id":"components/schemas/EnvelopeFileListResponse","kind":"json-schema","title":"EnvelopeFileListResponse","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeFileResponse"},"description":"The list of files."}},"additionalProperties":false,"description":"List of files."}},"components/schemas/EnvelopeFileResponse":{"id":"components/schemas/EnvelopeFileResponse","kind":"json-schema","title":"EnvelopeFileResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000020"},"name":{"type":"string","description":"The file name.","example":"contract.pdf"},"sortOrder":{"type":"integer","description":"The position of the file in the sequence.","format":"int32","example":1}},"additionalProperties":false,"description":"Representation of a file."}},"components/schemas/EnvelopeFileSummaryResponse":{"id":"components/schemas/EnvelopeFileSummaryResponse","kind":"json-schema","title":"EnvelopeFileSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000020"},"name":{"type":"string","description":"The file name.","example":"contract.pdf"},"sortOrder":{"type":"integer","description":"The file sort order.","format":"int32","example":1}},"additionalProperties":false,"description":"Summary of an envelope file."}},"components/schemas/EnvelopeListResponse":{"id":"components/schemas/EnvelopeListResponse","kind":"json-schema","title":"EnvelopeListResponse","data":{"required":["envelopes","pagination"],"type":"object","properties":{"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeSummary"},"description":"The list of envelopes."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of envelopes."}},"components/schemas/EnvelopeRecipientResponse":{"id":"components/schemas/EnvelopeRecipientResponse","kind":"json-schema","title":"EnvelopeRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"},"languageCode":{"type":"string","description":"The language code for the recipient's notifications.","nullable":true,"example":"en-US"}},"additionalProperties":false,"description":"Detailed representation of a recipient. Base for polymorphic response."}},"components/schemas/EnvelopeReminderResponse":{"id":"components/schemas/EnvelopeReminderResponse","kind":"json-schema","title":"EnvelopeReminderResponse","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/EnvelopeResponse":{"id":"components/schemas/EnvelopeResponse","kind":"json-schema","title":"EnvelopeResponse","data":{"required":["createdAt","fileRestrictedVisibility","files","id","qualifiedTimeStamp","signatureFormat","stages","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The envelope ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"The envelope name.","nullable":true,"example":"Contract for Mario Rossi"},"status":{"type":"string","description":"The current status of the envelope.","example":"Draft"},"createdAt":{"type":"string","description":"When the envelope was created.","format":"date-time","example":"2025-01-01T10:00:00Z"},"updatedAt":{"type":"string","description":"When the envelope was last updated.","format":"date-time","example":"2025-01-01T10:00:00Z"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteEnvelopeExpirationResponse"},{"$ref":"#/components/schemas/RelativeEnvelopeExpirationResponse"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/EnvelopeReminderResponse"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeStageSummaryResponse"},"description":"The stages of the envelope."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeFileSummaryResponse"},"description":"The files of the envelope."},"sentAt":{"type":"string","description":"When the envelope was sent.","format":"date-time","nullable":true,"example":"2025-01-02T12:00:00Z"},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the envelope must use a qualified timestamp server.","example":true},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"signatureReason":{"type":"string","description":"The signature reason persisted on the envelope, or null.","nullable":true,"example":"Approved by Mario Rossi"},"statusChangeReason":{"type":"string","description":"The reason for the envelope's terminal status change: the rejection reason when rejected, the cancellation reason when cancelled, otherwise null.","nullable":true,"example":"Document no longer required"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language, or null when no custom agreements are configured.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient.","example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope.","nullable":true,"example":"https://example.com/envelope-sent"},"bulkEnvelopeId":{"type":"string","description":"The ID of the bulk envelope this envelope was generated from, or null when the caller has no access to it or it is not a bulk child.","format":"uuid","nullable":true,"example":"00000000-0000-0000-0000-000000000002"}},"additionalProperties":false,"description":"Detailed representation of an envelope."}},"components/schemas/EnvelopeSortingKey":{"id":"components/schemas/EnvelopeSortingKey","kind":"json-schema","title":"EnvelopeSortingKey","data":{"enum":["LastUpdated","Name"],"type":"string","description":"The available sorting keys for listing envelopes."}},"components/schemas/EnvelopeStageAutomaticRecipientSummary":{"id":"components/schemas/EnvelopeStageAutomaticRecipientSummary","kind":"json-schema","title":"EnvelopeStageAutomaticRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/EnvelopeStageRecipientSummary"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile used for automatic signing.","nullable":true,"example":"default-eseal-profile"}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Stage summary for an Automatic signer recipient."}},"components/schemas/EnvelopeStageListResponse":{"id":"components/schemas/EnvelopeStageListResponse","kind":"json-schema","title":"EnvelopeStageListResponse","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeStageSummary"},"description":"The list of stages."}},"additionalProperties":false,"description":"List of stages."}},"components/schemas/EnvelopeStageRecipientSummary":{"id":"components/schemas/EnvelopeStageRecipientSummary","kind":"json-schema","title":"EnvelopeStageRecipientSummary","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"}},"additionalProperties":false,"description":"Summary representation of a stage recipient. Base for polymorphic response."}},"components/schemas/EnvelopeStageResponse":{"id":"components/schemas/EnvelopeStageResponse","kind":"json-schema","title":"EnvelopeStageResponse","data":{"required":["id","name","recipients","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"},"recipients":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EnvelopeStageStandardRecipientSummary"},{"$ref":"#/components/schemas/EnvelopeStageAutomaticRecipientSummary"}],"description":"Summary representation of a stage recipient. Base for polymorphic response."},"description":"The recipients of the stage."}},"additionalProperties":false,"description":"Detailed representation of a stage."}},"components/schemas/EnvelopeStageSortOrder":{"id":"components/schemas/EnvelopeStageSortOrder","kind":"json-schema","title":"EnvelopeStageSortOrder","data":{"required":["id","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"sortOrder":{"type":"integer","description":"The new position of the stage.","format":"int32","example":1}},"additionalProperties":false,"description":"Sort order entry for a stage."}},"components/schemas/EnvelopeStageStandardRecipientSummary":{"id":"components/schemas/EnvelopeStageStandardRecipientSummary","kind":"json-schema","title":"EnvelopeStageStandardRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/EnvelopeStageRecipientSummary"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Stage summary for a Recipient recipient."}},"components/schemas/EnvelopeStageSummary":{"id":"components/schemas/EnvelopeStageSummary","kind":"json-schema","title":"EnvelopeStageSummary","data":{"required":["id","name","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"}},"additionalProperties":false,"description":"Summary representation of a stage."}},"components/schemas/EnvelopeStageSummaryResponse":{"id":"components/schemas/EnvelopeStageSummaryResponse","kind":"json-schema","title":"EnvelopeStageSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000010"},"name":{"type":"string","description":"The stage name.","example":"Stage 1"},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32","example":1}},"additionalProperties":false,"description":"Stage summary within an envelope response."}},"components/schemas/EnvelopeStandardRecipientResponse":{"id":"components/schemas/EnvelopeStandardRecipientResponse","kind":"json-schema","title":"EnvelopeStandardRecipientResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/EnvelopeRecipientResponse"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/RecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/RecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Detailed representation of a Recipient recipient.","example":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached contract.","id":"00000000-0000-0000-0000-000000000100","languageCode":"en-US"}}},"components/schemas/EnvelopeStatusFilter":{"id":"components/schemas/EnvelopeStatusFilter","kind":"json-schema","title":"EnvelopeStatusFilter","data":{"enum":["Canceled","Completed","Draft","Expired","InProgress","Rejected"],"type":"string","description":"The available status values for filtering envelopes."}},"components/schemas/EnvelopeSummary":{"id":"components/schemas/EnvelopeSummary","kind":"json-schema","title":"EnvelopeSummary","data":{"required":["createdAt","id","name","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The envelope ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"The envelope name.","example":"Contract for Mario Rossi"},"status":{"type":"string","description":"The current status of the envelope.","example":"Draft"},"createdAt":{"type":"string","description":"When the envelope was created.","format":"date-time","example":"2025-01-01T10:00:00Z"},"updatedAt":{"type":"string","description":"When the envelope was last updated.","format":"date-time","example":"2025-01-01T10:00:00Z"},"sentAt":{"type":"string","description":"When the envelope was sent.","format":"date-time","nullable":true,"example":"2025-01-02T12:00:00Z"}},"additionalProperties":false,"description":"Summary representation of an envelope."}},"components/schemas/EnvelopeWebhookListResponse":{"id":"components/schemas/EnvelopeWebhookListResponse","kind":"json-schema","title":"EnvelopeWebhookListResponse","data":{"required":["webhooks"],"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeWebhookSummary"},"description":"The webhooks configured on the envelope."}},"additionalProperties":false,"description":"List of envelope webhooks."}},"components/schemas/EnvelopeWebhookResponse":{"id":"components/schemas/EnvelopeWebhookResponse","kind":"json-schema","title":"EnvelopeWebhookResponse","data":{"required":["createdAt","event","id","updatedAt","url"],"type":"object","properties":{"id":{"type":"string","description":"The webhook ID.","format":"uuid"},"url":{"type":"string","description":"The URL receiving the webhook calls."},"event":{"$ref":"#/components/schemas/WebhookEventType"},"createdAt":{"type":"string","description":"When the webhook was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the webhook was last updated.","format":"date-time"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationResponse"}},"additionalProperties":false,"description":"Detailed representation of an envelope webhook."}},"components/schemas/EnvelopeWebhookSummary":{"id":"components/schemas/EnvelopeWebhookSummary","kind":"json-schema","title":"EnvelopeWebhookSummary","data":{"required":["createdAt","event","id","updatedAt","url"],"type":"object","properties":{"id":{"type":"string","description":"The webhook ID.","format":"uuid"},"url":{"type":"string","description":"The URL receiving the webhook calls."},"event":{"$ref":"#/components/schemas/WebhookEventType"},"createdAt":{"type":"string","description":"When the webhook was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the webhook was last updated.","format":"date-time"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationResponse"}},"additionalProperties":false,"description":"Summary representation of an envelope webhook."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"required":["errorId","message","messageEn"],"type":"object","properties":{"errorId":{"type":"string"},"field":{"type":"string","nullable":true},"message":{},"messageEn":{},"additionalData":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/ErrorsResponse":{"id":"components/schemas/ErrorsResponse","kind":"json-schema","title":"ErrorsResponse","data":{"required":["errors"],"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponse"}}},"additionalProperties":false}},"components/schemas/ExpirationMode":{"id":"components/schemas/ExpirationMode","kind":"json-schema","title":"ExpirationMode","data":{"enum":["Absolute","Relative"],"type":"string","description":"The expiration mode of an envelope or template."}},"components/schemas/FieldTask":{"id":"components/schemas/FieldTask","kind":"json-schema","title":"FieldTask","data":{"required":["field","sortOrder","source"],"type":"object","properties":{"field":{"oneOf":[{"$ref":"#/components/schemas/SignatureField"},{"$ref":"#/components/schemas/TextInputField"},{"$ref":"#/components/schemas/CheckboxField"},{"$ref":"#/components/schemas/DropDownField"},{"$ref":"#/components/schemas/ListBoxField"},{"$ref":"#/components/schemas/AttachmentField"},{"$ref":"#/components/schemas/LinkField"},{"$ref":"#/components/schemas/FileReadConfirmationField"},{"$ref":"#/components/schemas/PageReadConfirmationField"},{"$ref":"#/components/schemas/AreaReadConfirmationField"},{"$ref":"#/components/schemas/ApprovalField"},{"$ref":"#/components/schemas/AnnotationField"},{"$ref":"#/components/schemas/RadioButtonField"},{"$ref":"#/components/schemas/InvisibleSignatureField"}],"description":"The field definition."},"recipientId":{"type":"string","description":"The ID of the recipient assigned to this task.","format":"uuid","nullable":true},"sortOrder":{"type":"integer","description":"The position of the task in the sequence.","format":"int32"},"source":{"$ref":"#/components/schemas/ElementSource"}},"additionalProperties":false,"description":"A task assigned to a field on a file."}},"components/schemas/FieldTaskListResponse":{"id":"components/schemas/FieldTaskListResponse","kind":"json-schema","title":"FieldTaskListResponse","data":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/FieldTask"},"description":"The list of tasks."}},"additionalProperties":false,"description":"List of field tasks."}},"components/schemas/FieldTaskRequest":{"id":"components/schemas/FieldTaskRequest","kind":"json-schema","title":"FieldTaskRequest","data":{"required":["field","sortOrder"],"type":"object","properties":{"field":{"oneOf":[{"$ref":"#/components/schemas/SignatureField"},{"$ref":"#/components/schemas/TextInputField"},{"$ref":"#/components/schemas/CheckboxField"},{"$ref":"#/components/schemas/DropDownField"},{"$ref":"#/components/schemas/ListBoxField"},{"$ref":"#/components/schemas/AttachmentField"},{"$ref":"#/components/schemas/LinkField"},{"$ref":"#/components/schemas/FileReadConfirmationField"},{"$ref":"#/components/schemas/PageReadConfirmationField"},{"$ref":"#/components/schemas/AreaReadConfirmationField"},{"$ref":"#/components/schemas/ApprovalField"},{"$ref":"#/components/schemas/AnnotationField"},{"$ref":"#/components/schemas/RadioButtonField"},{"$ref":"#/components/schemas/InvisibleSignatureField"}],"description":"The field definition."},"recipientId":{"type":"string","description":"The ID of the recipient assigned to this task.","format":"uuid","nullable":true},"sortOrder":{"type":"integer","description":"The position of the task in the sequence.","format":"int32"}},"additionalProperties":false,"description":"A task assigned to a field on a file."}},"components/schemas/FieldTaskType":{"id":"components/schemas/FieldTaskType","kind":"json-schema","title":"FieldTaskType","data":{"enum":["Signature","TextInput","Checkbox","DropDown","ListBox","Attachment","Link","FileReadConfirmation","PageReadConfirmation","AreaReadConfirmation","Approval","InvisibleSignature","Annotation","RadioButton"],"type":"string","description":"The type of field task."}},"components/schemas/FileMetadataValueResponse":{"id":"components/schemas/FileMetadataValueResponse","kind":"json-schema","title":"FileMetadataValueResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value of a file. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/FileReadConfirmationField":{"id":"components/schemas/FileReadConfirmationField","kind":"json-schema","title":"FileReadConfirmationField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["FileReadConfirmation"],"type":"string","default":"FileReadConfirmation"}},"description":"A file read confirmation field.","example":{"fieldType":"FileReadConfirmation","required":false,"id":"frc1"}}},"components/schemas/FileSortOrder":{"id":"components/schemas/FileSortOrder","kind":"json-schema","title":"FileSortOrder","data":{"required":["id","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid"},"sortOrder":{"type":"integer","description":"The new position of the file.","format":"int32"}},"additionalProperties":false,"description":"Sort order entry for a file."}},"components/schemas/FirstNameAnnotationValueFormat":{"id":"components/schemas/FirstNameAnnotationValueFormat","kind":"json-schema","title":"FirstNameAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["FirstName"],"type":"string","default":"FirstName"}},"additionalProperties":false,"description":"First name annotation value format."}},"components/schemas/FontStyle":{"id":"components/schemas/FontStyle","kind":"json-schema","title":"FontStyle","data":{"required":["align","bold","color","italic","name","size"],"type":"object","properties":{"size":{"type":"integer","description":"The font size.","format":"int32"},"name":{"type":"string","description":"The font name."},"color":{"type":"string","description":"The font color."},"align":{"$ref":"#/components/schemas/TextAlign"},"italic":{"type":"boolean","description":"Whether the font is italic."},"bold":{"type":"boolean","description":"Whether the font is bold."}},"additionalProperties":false,"description":"Font style configuration for a field."}},"components/schemas/FullNameAnnotationValueFormat":{"id":"components/schemas/FullNameAnnotationValueFormat","kind":"json-schema","title":"FullNameAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["FullName"],"type":"string","default":"FullName"}},"additionalProperties":false,"description":"Full name annotation value format."}},"components/schemas/GeneralSettings":{"id":"components/schemas/GeneralSettings","kind":"json-schema","title":"GeneralSettings","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The organization's name.","example":"name"}},"additionalProperties":false,"description":"The organization's general settings."}},"components/schemas/GuidNullableOptionalNullable":{"id":"components/schemas/GuidNullableOptionalNullable","kind":"json-schema","title":"GuidNullableOptionalNullable","data":{"required":["isSet"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"type":"string","format":"uuid","nullable":true,"readOnly":true}},"additionalProperties":false}},"components/schemas/IMandatoryAuthenticationOptional":{"id":"components/schemas/IMandatoryAuthenticationOptional","kind":"json-schema","title":"IMandatoryAuthenticationOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"oneOf":[{"$ref":"#/components/schemas/MandatoryAuthenticationNone"},{"$ref":"#/components/schemas/MandatoryAuthenticationAny"},{"$ref":"#/components/schemas/MandatoryAuthenticationAccessCode"},{"$ref":"#/components/schemas/MandatoryAuthenticationOneTimePassword"},{"$ref":"#/components/schemas/MandatoryAuthenticationOAuth"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's mandatory (forced) recipient authentication method. Discriminated by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"None\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Any\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AccessCode\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OneTimePassword\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"OAuth\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true}},"additionalProperties":false}},"components/schemas/InitialsAnnotationValueFormat":{"id":"components/schemas/InitialsAnnotationValueFormat","kind":"json-schema","title":"InitialsAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["Initials"],"type":"string","default":"Initials"}},"additionalProperties":false,"description":"Initials annotation value format."}},"components/schemas/InvisibleSignatureField":{"id":"components/schemas/InvisibleSignatureField","kind":"json-schema","title":"InvisibleSignatureField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"allowedSignatureTypes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/LocalCertificateSignature"},{"$ref":"#/components/schemas/DisposableCertificateSignature"},{"$ref":"#/components/schemas/RemoteCertificateSignature"},{"$ref":"#/components/schemas/PluginSignature"}],"description":"Base invisible (CAdES, non-positional) signature type configuration."},"description":"The allowed signature types for this field.","nullable":true},"qualifiedTimeStamp":{"type":"boolean","description":"Whether the signature must use a qualified timestamp server.","nullable":true}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["InvisibleSignature"],"type":"string","default":"InvisibleSignature"}},"description":"A CAdES (non-positional, document-level) signature field task.","example":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"},{"signatureType":"LocalCertificateSignature"},{"signatureType":"PluginSignature","pluginId":"ArubaGsp"},{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"}}},"components/schemas/LanguageListResponse":{"id":"components/schemas/LanguageListResponse","kind":"json-schema","title":"LanguageListResponse","data":{"required":["languages"],"type":"object","properties":{"languages":{"type":"array","items":{"$ref":"#/components/schemas/LanguageResponse"},"description":"The list of languages."}},"additionalProperties":false,"description":"List of available languages."}},"components/schemas/LanguageResponse":{"id":"components/schemas/LanguageResponse","kind":"json-schema","title":"LanguageResponse","data":{"required":["code","name"],"type":"object","properties":{"code":{"type":"string","description":"The BCP 47 language code.","example":"en"},"name":{"type":"string","description":"The display name of the language.","example":"English"}},"additionalProperties":false,"description":"A language available for selection."}},"components/schemas/LanguageSettings":{"id":"components/schemas/LanguageSettings","kind":"json-schema","title":"LanguageSettings","data":{"required":["languages"],"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"},"description":"The language codes enabled for the organization, in alphabetical order."}},"additionalProperties":false,"description":"The organization's enabled languages."}},"components/schemas/LastNameAnnotationValueFormat":{"id":"components/schemas/LastNameAnnotationValueFormat","kind":"json-schema","title":"LastNameAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["LastName"],"type":"string","default":"LastName"}},"additionalProperties":false,"description":"Last name annotation value format."}},"components/schemas/LinkField":{"id":"components/schemas/LinkField","kind":"json-schema","title":"LinkField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"reference":{"type":"string","description":"The Reference of the link.","nullable":true}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Link"],"type":"string","default":"Link"}},"description":"A link field.","example":{"fieldType":"Link","reference":"https://example.com","positionX":50,"positionY":700,"width":150,"height":30,"page":1,"id":"lnk1"}}},"components/schemas/ListBoxField":{"id":"components/schemas/ListBoxField","kind":"json-schema","title":"ListBoxField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"font":{"$ref":"#/components/schemas/FontStyle"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"},"description":"The list of options.","nullable":true},"multiselect":{"type":"boolean","description":"Whether multiple options can be selected."},"readOnly":{"type":"boolean","description":"Whether the field is read-only."},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["ListBox"],"type":"string","default":"ListBox"}},"description":"A list box field.","example":{"fieldType":"ListBox","font":{"size":12,"name":"Helvetica","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"multiselect":true,"readOnly":false,"required":false,"positionX":50,"positionY":500,"width":150,"height":80,"page":1,"id":"lb1"}}},"components/schemas/ListOptionDocumentClassMetadataResponse":{"id":"components/schemas/ListOptionDocumentClassMetadataResponse","kind":"json-schema","title":"ListOptionDocumentClassMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentClassMetadataResponse"},{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadataOptionItem"},"description":"The predefined selectable options.","nullable":true},"parentId":{"type":"string","description":"The ID of the parent metadata field this field depends on, when defined.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":"A document class metadata field carrying a predefined list of selectable options.","example":{"options":[{"id":"5f122cda-33a6-4739-826f-325232fd46c6","value":"Invoice","parentId":"d37041eb-c544-4c76-a7c3-036510ab7c46"},{"id":"8283318b-1c11-4226-a836-4a299a284241","value":"NDA"}],"parentId":"543053b6-f157-4cc8-a5ff-e8aaa3431cf7","type":"ListOptionType","id":"4dcc5e5e-dfc9-4dbd-9c41-7505becc470d","name":"ContractType","required":true,"sortOrder":4}}},"components/schemas/ListOptionDocumentMetadataItem":{"id":"components/schemas/ListOptionDocumentMetadataItem","kind":"json-schema","title":"ListOptionDocumentMetadataItem","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentMetadataItem"},{"type":"object","properties":{"parentId":{"type":"string","description":"The ID of the parent metadata field this field depends on, when defined.","format":"uuid","nullable":true},"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadataOptionItem"},"description":"The predefined selectable options.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization-level document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.ListOptionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"parentId":"18eb3dde-4e35-4c62-b967-ed2749bb5a86","options":[{"id":"090ea74a-6ec9-48cf-9ba9-c4bcc942adc4","value":"Invoice","parentId":"68fd57fe-9ccc-4093-bbf2-df600972880d"},{"id":"c8fad119-b9ca-45a7-a7f4-8b10a2df2cc4","value":"NDA"}],"type":"ListOptionType","id":"ae3df14a-38f7-4a15-a83b-67e24377ad6c","name":"ContractType"}}},"components/schemas/ListOptionFileMetadataValueResponse":{"id":"components/schemas/ListOptionFileMetadataValueResponse","kind":"json-schema","title":"ListOptionFileMetadataValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/FileMetadataValueResponse"},{"type":"object","properties":{"value":{"type":"string","description":"The ID of the selected option, or null if not set.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":"A list option metadata value of a file.","example":{"value":"211e1b27-0e46-4ff5-96fa-a8d9edd1145e","type":"ListOptionType","id":"1009bc97-23ea-4bf6-b931-1a7542064965","name":"ContractType"}}},"components/schemas/ListOptionMetadataValueRequest":{"id":"components/schemas/ListOptionMetadataValueRequest","kind":"json-schema","title":"ListOptionMetadataValueRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/MetadataValueRequest"},{"type":"object","properties":{"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the selected option, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the field."},"children":[]}]}]}],"format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":"A metadata value carrying one option selected from a predefined, per-field set of allowed options."}},"components/schemas/ListOptionPolicyConditionMetadataRequest":{"id":"components/schemas/ListOptionPolicyConditionMetadataRequest","kind":"json-schema","title":"ListOptionPolicyConditionMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataRequest"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison list option id (not its display text/label).","format":"uuid"}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":"A policy condition's comparison value for a list-option-type metadata field."}},"components/schemas/ListOptionPolicyConditionValueResponse":{"id":"components/schemas/ListOptionPolicyConditionValueResponse","kind":"json-schema","title":"ListOptionPolicyConditionValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataResponse"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison list option id (not its display text/label).","format":"uuid"}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":"A policy condition's comparison value for a list-option-type metadata field."}},"components/schemas/LocalCertificateSignature":{"id":"components/schemas/LocalCertificateSignature","kind":"json-schema","title":"LocalCertificateSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["LocalCertificateSignature"],"type":"string","default":"LocalCertificateSignature"}},"additionalProperties":false,"description":"Local certificate signature configuration.","example":{"signatureType":"LocalCertificateSignature"}}},"components/schemas/MandatoryAuthenticationAccessCode":{"id":"components/schemas/MandatoryAuthenticationAccessCode","kind":"json-schema","title":"MandatoryAuthenticationAccessCode","data":{"required":["authentication"],"type":"object","properties":{"authentication":{"enum":["AccessCode"],"type":"string","default":"AccessCode"}},"additionalProperties":false,"description":"Access code authentication is mandatory."}},"components/schemas/MandatoryAuthenticationAny":{"id":"components/schemas/MandatoryAuthenticationAny","kind":"json-schema","title":"MandatoryAuthenticationAny","data":{"required":["authentication"],"type":"object","properties":{"authentication":{"enum":["Any"],"type":"string","default":"Any"}},"additionalProperties":false,"description":"Any authentication method may be used to satisfy the mandatory authentication requirement."}},"components/schemas/MandatoryAuthenticationNone":{"id":"components/schemas/MandatoryAuthenticationNone","kind":"json-schema","title":"MandatoryAuthenticationNone","data":{"required":["authentication"],"type":"object","properties":{"authentication":{"enum":["None"],"type":"string","default":"None"}},"additionalProperties":false,"description":"No mandatory authentication method is enforced."}},"components/schemas/MandatoryAuthenticationOAuth":{"id":"components/schemas/MandatoryAuthenticationOAuth","kind":"json-schema","title":"MandatoryAuthenticationOAuth","data":{"required":["authentication","oAuthProviderId"],"type":"object","properties":{"authentication":{"enum":["OAuth"],"type":"string","default":"OAuth"},"oAuthProviderId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external ID of the OAuth provider that must be used, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /settings/oauth-providers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"uuid","example":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}},"additionalProperties":false,"description":"OAuth authentication with a specific provider is mandatory."}},"components/schemas/MandatoryAuthenticationOneTimePassword":{"id":"components/schemas/MandatoryAuthenticationOneTimePassword","kind":"json-schema","title":"MandatoryAuthenticationOneTimePassword","data":{"required":["authentication"],"type":"object","properties":{"authentication":{"enum":["OneTimePassword"],"type":"string","default":"OneTimePassword"}},"additionalProperties":false,"description":"One-time password authentication is mandatory."}},"components/schemas/MandatoryAuthenticationType":{"id":"components/schemas/MandatoryAuthenticationType","kind":"json-schema","title":"MandatoryAuthenticationType","data":{"enum":["None","Any","AccessCode","OneTimePassword","OAuth"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mandatory authentication method values supported by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator."},"children":[]}]}]}]}},"components/schemas/MetadataValueRequest":{"id":"components/schemas/MetadataValueRequest","kind":"json-schema","title":"MetadataValueRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/MetadataValueType":{"id":"components/schemas/MetadataValueType","kind":"json-schema","title":"MetadataValueType","data":{"enum":["StringType","NumberType","DateType","ListOptionType"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type of a document-class metadata field value, used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator."},"children":[]}]}]}]}},"components/schemas/NextRecipientDto":{"id":"components/schemas/NextRecipientDto","kind":"json-schema","title":"NextRecipientDto","data":{"required":["givenName","id","surname","type"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid","example":"00000000-0000-0000-0000-000000000100"},"givenName":{"type":"string","description":"The recipient's given name.","example":"Mario"},"surname":{"type":"string","description":"The recipient's surname.","example":"Rossi"},"type":{"$ref":"#/components/schemas/NextRecipientType"}},"additionalProperties":false,"description":"Represents a next recipient in the signing workflow."}},"components/schemas/NextRecipientLinkDto":{"id":"components/schemas/NextRecipientLinkDto","kind":"json-schema","title":"NextRecipientLinkDto","data":{"required":["link","recipient"],"type":"object","properties":{"recipient":{"$ref":"#/components/schemas/NextRecipientDto"},"link":{"type":"string","description":"The action link for the recipient.","example":"https://sign.example.com/recipient/00000000-0000-0000-0000-000000000100"}},"additionalProperties":false,"description":"Represents a next recipient with their action link."}},"components/schemas/NextRecipientLinksResponse":{"id":"components/schemas/NextRecipientLinksResponse","kind":"json-schema","title":"NextRecipientLinksResponse","data":{"required":["nextRecipientLinks"],"type":"object","properties":{"nextRecipientLinks":{"type":"array","items":{"$ref":"#/components/schemas/NextRecipientLinkDto"},"description":"The list of next recipient links."}},"additionalProperties":false,"description":"Response containing next recipient links."}},"components/schemas/NextRecipientType":{"id":"components/schemas/NextRecipientType","kind":"json-schema","title":"NextRecipientType","data":{"enum":["Signer","Automatic","Approver","Viewer"],"type":"string","description":"Type of next recipient in the signing workflow."}},"components/schemas/NotificationChannel":{"id":"components/schemas/NotificationChannel","kind":"json-schema","title":"NotificationChannel","data":{"enum":["None","Email","Sms","WhatsApp"],"type":"string","description":"The notification delivery channel."}},"components/schemas/NumberDocumentClassMetadataResponse":{"id":"components/schemas/NumberDocumentClassMetadataResponse","kind":"json-schema","title":"NumberDocumentClassMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentClassMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":"A document class metadata field carrying a numeric value.","example":{"type":"NumberType","id":"4a44beaa-2c32-43d0-8130-00bb8e2b1cb0","name":"TotalAmount","required":true,"sortOrder":2}}},"components/schemas/NumberDocumentMetadataItem":{"id":"components/schemas/NumberDocumentMetadataItem","kind":"json-schema","title":"NumberDocumentMetadataItem","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentMetadataItem"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization-level document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.NumberType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"NumberType","id":"d481d30e-37b2-4e94-942b-82ee7d110866","name":"TotalAmount"}}},"components/schemas/NumberFileMetadataValueResponse":{"id":"components/schemas/NumberFileMetadataValueResponse","kind":"json-schema","title":"NumberFileMetadataValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/FileMetadataValueResponse"},{"type":"object","properties":{"value":{"type":"number","description":"The numeric value, or null if not set.","format":"double","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":"A numeric (decimal) metadata value of a file.","example":{"value":100.9,"type":"NumberType","id":"2f4d9262-560a-49ee-a49b-d6364364971f","name":"Amount"}}},"components/schemas/NumberInputConfig":{"id":"components/schemas/NumberInputConfig","kind":"json-schema","title":"NumberInputConfig","data":{"required":["decimalPlaces","decimalSeparator","textInputType","thousandsSeparator"],"type":"object","properties":{"textInputType":{"enum":["NumberType"],"type":"string","default":"NumberType"},"value":{"type":"number","description":"The numeric value.","format":"double","nullable":true},"thousandsSeparator":{"$ref":"#/components/schemas/ThousandsSeparator"},"decimalSeparator":{"$ref":"#/components/schemas/DecimalSeparator"},"symbol":{"$ref":"#/components/schemas/NumberSymbol"},"decimalPlaces":{"type":"integer","description":"The number of decimal places.","format":"int32"},"minValue":{"type":"number","description":"The minimum allowed value.","format":"double","nullable":true},"maxValue":{"type":"number","description":"The maximum allowed value.","format":"double","nullable":true}},"additionalProperties":false,"description":"Configuration for a number text input.","example":{"textInputType":"NumberType","value":42.51,"thousandsSeparator":"Point","decimalSeparator":"Comma","symbol":{"value":"€","position":"Start"},"decimalPlaces":2,"minValue":10.25,"maxValue":1000.78}}},"components/schemas/NumberMetadataValueRequest":{"id":"components/schemas/NumberMetadataValueRequest","kind":"json-schema","title":"NumberMetadataValueRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/MetadataValueRequest"},{"type":"object","properties":{"value":{"type":"number","description":"The numeric value.","format":"double"}},"additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":"A metadata value carrying a numeric (decimal) payload."}},"components/schemas/NumberPolicyConditionMetadataRequest":{"id":"components/schemas/NumberPolicyConditionMetadataRequest","kind":"json-schema","title":"NumberPolicyConditionMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataRequest"},{"required":["value"],"type":"object","properties":{"value":{"type":"number","description":"The comparison numeric value.","format":"double"}},"additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":"A policy condition's comparison value for a number-type metadata field."}},"components/schemas/NumberPolicyConditionValueResponse":{"id":"components/schemas/NumberPolicyConditionValueResponse","kind":"json-schema","title":"NumberPolicyConditionValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataResponse"},{"required":["value"],"type":"object","properties":{"value":{"type":"number","description":"The comparison numeric value.","format":"double"}},"additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":"A policy condition's comparison value for a number-type metadata field."}},"components/schemas/NumberSymbol":{"id":"components/schemas/NumberSymbol","kind":"json-schema","title":"NumberSymbol","data":{"required":["position"],"type":"object","properties":{"value":{"type":"string","description":"The currency or unit symbol value.","nullable":true},"position":{"$ref":"#/components/schemas/SymbolPosition"}},"additionalProperties":false,"description":"The currency or unit symbol of a number input and its position."}},"components/schemas/OAuthAuthentication":{"id":"components/schemas/OAuthAuthentication","kind":"json-schema","title":"OAuthAuthentication","data":{"type":"object","properties":{"providerName":{"type":"string","description":"The OAuth provider name.","nullable":true},"id":{"type":"string","description":"The identifier of the OAuth provider.","format":"uuid","nullable":true}},"additionalProperties":false,"description":"OAuth authentication configuration."}},"components/schemas/OAuthProviderListResponse":{"id":"components/schemas/OAuthProviderListResponse","kind":"json-schema","title":"OAuthProviderListResponse","data":{"required":["oAuthProviders","pagination"],"type":"object","properties":{"oAuthProviders":{"type":"array","items":{"$ref":"#/components/schemas/OAuthProviderSummary"},"description":"The list of OAuth providers."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of OAuth providers."}},"components/schemas/OAuthProviderSummary":{"id":"components/schemas/OAuthProviderSummary","kind":"json-schema","title":"OAuthProviderSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The OAuth provider identifier.","format":"uuid"},"name":{"type":"string","description":"The display name of the OAuth provider."}},"additionalProperties":false,"description":"Summary representation of an OAuth provider."}},"components/schemas/OneTimePasswordAuthenticationChannel":{"id":"components/schemas/OneTimePasswordAuthenticationChannel","kind":"json-schema","title":"OneTimePasswordAuthenticationChannel","data":{"enum":["Sms"],"type":"string","description":"Delivery channel used to send the OTP for recipient authentication."}},"components/schemas/OneTimePasswordSettings":{"id":"components/schemas/OneTimePasswordSettings","kind":"json-schema","title":"OneTimePasswordSettings","data":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether one time password authentication is enabled."}},"additionalProperties":false,"description":"The one-time password authentication configuration."}},"components/schemas/OneTimePasswordSignature":{"id":"components/schemas/OneTimePasswordSignature","kind":"json-schema","title":"OneTimePasswordSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["OneTimePasswordSignature"],"type":"string","default":"OneTimePasswordSignature"}},"additionalProperties":false,"description":"One-time password signature configuration.","example":{"signatureType":"OneTimePasswordSignature"}}},"components/schemas/Option":{"id":"components/schemas/Option","kind":"json-schema","title":"Option","data":{"required":["key","selected","value"],"type":"object","properties":{"key":{"type":"string","description":"The option key."},"value":{"type":"string","description":"The option value."},"selected":{"type":"boolean","description":"Whether the option is selected."}},"additionalProperties":false,"description":"An option for a selectable field."}},"components/schemas/OrganizationWebhookListResponse":{"id":"components/schemas/OrganizationWebhookListResponse","kind":"json-schema","title":"OrganizationWebhookListResponse","data":{"required":["webhooks"],"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationWebhookSummary"},"description":"The webhooks configured on the organization."}},"additionalProperties":false,"description":"List of organization webhooks."}},"components/schemas/OrganizationWebhookResponse":{"id":"components/schemas/OrganizationWebhookResponse","kind":"json-schema","title":"OrganizationWebhookResponse","data":{"required":["createdAt","event","id","updatedAt","url"],"type":"object","properties":{"id":{"type":"string","description":"The webhook ID.","format":"uuid"},"url":{"type":"string","description":"The URL receiving the webhook calls."},"event":{"$ref":"#/components/schemas/WebhookEventType"},"createdAt":{"type":"string","description":"When the webhook was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the webhook was last updated.","format":"date-time"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationResponse"}},"additionalProperties":false,"description":"Detailed representation of an organization webhook."}},"components/schemas/OrganizationWebhookSummary":{"id":"components/schemas/OrganizationWebhookSummary","kind":"json-schema","title":"OrganizationWebhookSummary","data":{"required":["createdAt","event","id","updatedAt","url"],"type":"object","properties":{"id":{"type":"string","description":"The webhook ID.","format":"uuid"},"url":{"type":"string","description":"The URL receiving the webhook calls."},"event":{"$ref":"#/components/schemas/WebhookEventType"},"createdAt":{"type":"string","description":"When the webhook was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the webhook was last updated.","format":"date-time"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationResponse"}},"additionalProperties":false,"description":"Summary representation of an organization webhook."}},"components/schemas/OtpDeliveryChannel":{"id":"components/schemas/OtpDeliveryChannel","kind":"json-schema","title":"OtpDeliveryChannel","data":{"enum":["Sms","Email"],"type":"string","description":"Delivery channel used to send the OTP to the recipient."}},"components/schemas/OtpSignature":{"id":"components/schemas/OtpSignature","kind":"json-schema","title":"OtpSignature","data":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OtpDeliveryChannel"}},"additionalProperties":false,"description":"OTP signature configuration."}},"components/schemas/PageReadConfirmationField":{"id":"components/schemas/PageReadConfirmationField","kind":"json-schema","title":"PageReadConfirmationField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["PageReadConfirmation"],"type":"string","default":"PageReadConfirmation"}},"description":"A page read confirmation field.","example":{"fieldType":"PageReadConfirmation","required":false,"page":1,"id":"prc1"}}},"components/schemas/PaginationResponse":{"id":"components/schemas/PaginationResponse","kind":"json-schema","title":"PaginationResponse","data":{"required":["page","pageSize","totalCount"],"type":"object","properties":{"page":{"type":"integer","description":"The current page number.","format":"int32"},"pageSize":{"type":"integer","description":"The number of items per page.","format":"int32"},"totalCount":{"type":"integer","description":"The total number of items.","format":"int32"}},"additionalProperties":false,"description":"Pagination metadata."}},"components/schemas/PatchBulkEnvelopeFilesRequest":{"id":"components/schemas/PatchBulkEnvelopeFilesRequest","kind":"json-schema","title":"PatchBulkEnvelopeFilesRequest","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/FileSortOrder"},"description":"The new file ordering."}},"additionalProperties":false,"description":"Request body for reordering bulk envelope files."}},"components/schemas/PatchBulkEnvelopeStagesRequest":{"id":"components/schemas/PatchBulkEnvelopeStagesRequest","kind":"json-schema","title":"PatchBulkEnvelopeStagesRequest","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeStageSortOrder"},"description":"The new stage ordering."}},"additionalProperties":false,"description":"Request body for reordering bulk envelope stages."}},"components/schemas/PatchEnvelopeFilesRequest":{"id":"components/schemas/PatchEnvelopeFilesRequest","kind":"json-schema","title":"PatchEnvelopeFilesRequest","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/FileSortOrder"},"description":"The new file ordering."}},"additionalProperties":false,"description":"Request body for reordering files."}},"components/schemas/PatchEnvelopeStagesRequest":{"id":"components/schemas/PatchEnvelopeStagesRequest","kind":"json-schema","title":"PatchEnvelopeStagesRequest","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/EnvelopeStageSortOrder"},"description":"The new stage ordering."}},"additionalProperties":false,"description":"Request body for reordering stages."}},"components/schemas/PatchTemplateFilesRequest":{"id":"components/schemas/PatchTemplateFilesRequest","kind":"json-schema","title":"PatchTemplateFilesRequest","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/FileSortOrder"},"description":"The new file ordering."}},"additionalProperties":false,"description":"Request body for reordering files."}},"components/schemas/PatchTemplateStagesRequest":{"id":"components/schemas/PatchTemplateStagesRequest","kind":"json-schema","title":"PatchTemplateStagesRequest","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStageSortOrder"},"description":"The new stage ordering."}},"additionalProperties":false,"description":"Request body for reordering stages."}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"required":["action","entity"],"type":"object","properties":{"entity":{"$ref":"#/components/schemas/PermissionEntity"},"action":{"$ref":"#/components/schemas/PermissionAction"}},"additionalProperties":false,"description":"A single entity/action permission pair granted by an application role."}},"components/schemas/PermissionAction":{"id":"components/schemas/PermissionAction","kind":"json-schema","title":"PermissionAction","data":{"enum":["Read","Write"],"type":"string","description":"The action an application role permission grants on an entity."}},"components/schemas/PermissionEntity":{"id":"components/schemas/PermissionEntity","kind":"json-schema","title":"PermissionEntity","data":{"enum":["Envelope","Template","Organization","User","UserGroup"],"type":"string","description":"The domain entity an application role permission applies to."}},"components/schemas/PhoneNumberInputConfig":{"id":"components/schemas/PhoneNumberInputConfig","kind":"json-schema","title":"PhoneNumberInputConfig","data":{"required":["format","textInputType","value"],"type":"object","properties":{"textInputType":{"enum":["PhoneNumberType"],"type":"string","default":"PhoneNumberType"},"value":{"type":"string","description":"The phone number value."},"format":{"$ref":"#/components/schemas/PhoneType"}},"additionalProperties":false,"description":"Configuration for a phone number text input.","example":{"textInputType":"PhoneNumberType","value":"+393331234567","format":"InternationalLeadingPlus"}}},"components/schemas/PhoneType":{"id":"components/schemas/PhoneType","kind":"json-schema","title":"PhoneType","data":{"enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string","description":"The phone number display format of a phone number text input."}},"components/schemas/PluginSignature":{"id":"components/schemas/PluginSignature","kind":"json-schema","title":"PluginSignature","data":{"required":["pluginId","signatureType"],"type":"object","properties":{"pluginId":{"type":"string","description":"The plugin ID."},"signatureType":{"enum":["PluginSignature"],"type":"string","default":"PluginSignature"}},"additionalProperties":false,"description":"Plugin signature configuration.","example":{"pluginId":"ArubaGsp","signatureType":"PluginSignature"}}},"components/schemas/PolicyActionRequest":{"id":"components/schemas/PolicyActionRequest","kind":"json-schema","title":"PolicyActionRequest","data":{"required":["sortOrder"],"type":"object","properties":{"sortOrder":{"type":"integer","description":"The action's position within the policy. Must start at 1, be unique, and contiguous within the actions list.","format":"int32"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single action within a policy request. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/PolicyActionResponse":{"id":"components/schemas/PolicyActionResponse","kind":"json-schema","title":"PolicyActionResponse","data":{"required":["id","recipientSource","sortOrder","stage","type"],"type":"object","properties":{"id":{"type":"string","description":"The action ID.","format":"uuid"},"type":{"$ref":"#/components/schemas/PolicyActionType"},"stage":{"$ref":"#/components/schemas/StageConfigurationResponse"},"recipientSource":{"oneOf":[{"$ref":"#/components/schemas/StaticPolicyRecipientSourceResponse"},{"$ref":"#/components/schemas/DynamicPolicyRecipientSourceResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action's recipient source, discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"sortOrder":{"type":"integer","description":"The action's position within the policy.","format":"int32","example":1}},"additionalProperties":false,"description":"A single action within a policy."}},"components/schemas/PolicyActionType":{"id":"components/schemas/PolicyActionType","kind":"json-schema","title":"PolicyActionType","data":{"enum":["AddEnvelopeStageConfiguration"],"type":"string","description":"The kind of action performed by a policy."}},"components/schemas/PolicyConditionMetadataRequest":{"id":"components/schemas/PolicyConditionMetadataRequest","kind":"json-schema","title":"PolicyConditionMetadataRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The document metadata field ID this condition evaluates.","format":"uuid"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A policy condition's metadata field and comparison value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/PolicyConditionMetadataResponse":{"id":"components/schemas/PolicyConditionMetadataResponse","kind":"json-schema","title":"PolicyConditionMetadataResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The document metadata field ID this condition evaluates.","format":"uuid"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A policy condition's metadata field and comparison value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/PolicyConditionOperator":{"id":"components/schemas/PolicyConditionOperator","kind":"json-schema","title":"PolicyConditionOperator","data":{"enum":["GreaterThan","LessThan","Equals"],"type":"string","description":"The comparison operator applied by a policy condition."}},"components/schemas/PolicyConditionRequest":{"id":"components/schemas/PolicyConditionRequest","kind":"json-schema","title":"PolicyConditionRequest","data":{"required":["metadata","operator","sortOrder"],"type":"object","properties":{"operator":{"$ref":"#/components/schemas/PolicyConditionOperator"},"sortOrder":{"type":"integer","description":"The condition's position within the policy. Must start at 1, be unique, and contiguous within the conditions list.","format":"int32","example":1},"metadata":{"oneOf":[{"$ref":"#/components/schemas/StringPolicyConditionMetadataRequest"},{"$ref":"#/components/schemas/NumberPolicyConditionMetadataRequest"},{"$ref":"#/components/schemas/DatePolicyConditionMetadataRequest"},{"$ref":"#/components/schemas/ListOptionPolicyConditionMetadataRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document metadata field this condition evaluates, and its comparison value, discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"additionalProperties":false,"description":"A single condition within a policy request."}},"components/schemas/PolicyConditionResponse":{"id":"components/schemas/PolicyConditionResponse","kind":"json-schema","title":"PolicyConditionResponse","data":{"required":["id","metadata","operator","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The condition ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"operator":{"$ref":"#/components/schemas/PolicyConditionOperator"},"sortOrder":{"type":"integer","description":"The condition's position within the policy.","format":"int32","example":1},"metadata":{"oneOf":[{"$ref":"#/components/schemas/StringPolicyConditionValueResponse"},{"$ref":"#/components/schemas/NumberPolicyConditionValueResponse"},{"$ref":"#/components/schemas/DatePolicyConditionValueResponse"},{"$ref":"#/components/schemas/ListOptionPolicyConditionValueResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document metadata field this condition evaluates, and its comparison value, discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"additionalProperties":false,"description":"A single condition within a policy."}},"components/schemas/PolicyListResponse":{"id":"components/schemas/PolicyListResponse","kind":"json-schema","title":"PolicyListResponse","data":{"required":["pagination","policies"],"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicySummary"},"description":"The list of policies."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of policies."}},"components/schemas/PolicyRecipientRequest":{"id":"components/schemas/PolicyRecipientRequest","kind":"json-schema","title":"PolicyRecipientRequest","data":{"required":["email","givenName","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's given name."},"surname":{"type":"string","description":"The recipient's surname."},"email":{"type":"string","description":"The recipient's email address."},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true}},"additionalProperties":false,"description":"A recipient of a static policy recipient source."}},"components/schemas/PolicyRecipientResponse":{"id":"components/schemas/PolicyRecipientResponse","kind":"json-schema","title":"PolicyRecipientResponse","data":{"required":["email","givenName","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's given name."},"surname":{"type":"string","description":"The recipient's surname."},"email":{"type":"string","description":"The recipient's email address."},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true}},"additionalProperties":false,"description":"A recipient of a static policy recipient source."}},"components/schemas/PolicyRecipientSourceRequest":{"id":"components/schemas/PolicyRecipientSourceRequest","kind":"json-schema","title":"PolicyRecipientSourceRequest","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A policy action's recipient source, discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/PolicyRecipientSourceType":{"id":"components/schemas/PolicyRecipientSourceType","kind":"json-schema","title":"PolicyRecipientSourceType","data":{"enum":["Static","Dynamic"],"type":"string","description":"The kind of recipient source applied by a policy action."}},"components/schemas/PolicyResponse":{"id":"components/schemas/PolicyResponse","kind":"json-schema","title":"PolicyResponse","data":{"required":["actions","conditions","id","isActive","name"],"type":"object","properties":{"id":{"type":"string","description":"The policy ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The policy name.","example":"Standard signing policy"},"isActive":{"type":"boolean","description":"Whether the policy is active.","example":true},"description":{"type":"string","description":"The policy description.","nullable":true,"example":"Policy applied to all standard signing envelopes"},"documentClassId":{"type":"string","description":"The document class this policy applies to, when set.","format":"uuid","nullable":true},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/PolicyConditionResponse"},"description":"The policy's conditions."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/PolicyActionResponse"},"description":"The policy's actions."}},"additionalProperties":false,"description":"Full representation of a policy, including its conditions and actions."}},"components/schemas/PolicySortingKey":{"id":"components/schemas/PolicySortingKey","kind":"json-schema","title":"PolicySortingKey","data":{"enum":["Name","Description","IsActive"],"type":"string","description":"The available sorting keys for listing policies."}},"components/schemas/PolicySummary":{"id":"components/schemas/PolicySummary","kind":"json-schema","title":"PolicySummary","data":{"required":["id","isActive","name"],"type":"object","properties":{"id":{"type":"string","description":"The policy ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The policy name.","example":"Standard signing policy"},"isActive":{"type":"boolean","description":"Whether the policy is active.","example":true},"description":{"type":"string","description":"The policy description.","nullable":true,"example":"Policy applied to all standard signing envelopes"}},"additionalProperties":false,"description":"Summary representation of a policy."}},"components/schemas/RadioButtonField":{"id":"components/schemas/RadioButtonField","kind":"json-schema","title":"RadioButtonField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"groupName":{"type":"string","description":"The group name for the radio button.","nullable":true},"checked":{"type":"boolean","description":"Whether the radio button is checked."},"readOnly":{"type":"boolean","description":"Whether the radio button is read-only."},"value":{"type":"string","description":"The value of the radio button.","nullable":true},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["RadioButton"],"type":"string","default":"RadioButton"}},"description":"A radio button field.","example":{"fieldType":"RadioButton","groupName":"group1","checked":false,"readOnly":false,"value":"option1","required":true,"positionX":100,"positionY":200,"width":20,"height":20,"page":1,"id":"rb1"}}},"components/schemas/RecipientAuthentication":{"id":"components/schemas/RecipientAuthentication","kind":"json-schema","title":"RecipientAuthentication","data":{"type":"object","properties":{"accessCode":{"$ref":"#/components/schemas/AccessCode"},"oneTimePassword":{"$ref":"#/components/schemas/AuthenticationOneTimePassword"},"oAuthAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAuthentication"},"description":"OAuth authentications.","nullable":true}},"additionalProperties":false,"description":"Recipient authentication configuration."}},"components/schemas/RecipientAuthenticationSettings":{"id":"components/schemas/RecipientAuthenticationSettings","kind":"json-schema","title":"RecipientAuthenticationSettings","data":{"required":["accessCode"],"type":"object","properties":{"accessCode":{"type":"boolean","description":"Whether access code authentication is enabled."},"oneTimePassword":{"$ref":"#/components/schemas/OneTimePasswordSettings"}},"additionalProperties":false,"description":"The organization's recipient authentication settings."}},"components/schemas/RecipientDelegation":{"id":"components/schemas/RecipientDelegation","kind":"json-schema","title":"RecipientDelegation","data":{"enum":["notAllowed","allowedDisabled","allowedEnabled"],"type":"string","description":"The recipient delegation policies supported by the settings/recipient endpoint."}},"components/schemas/RecipientDelegationOptional":{"id":"components/schemas/RecipientDelegationOptional","kind":"json-schema","title":"RecipientDelegationOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/RecipientDelegation"}},"additionalProperties":false}},"components/schemas/RecipientMetadataEntry":{"id":"components/schemas/RecipientMetadataEntry","kind":"json-schema","title":"RecipientMetadataEntry","data":{"required":["name","value"],"type":"object","properties":{"name":{"type":"string","description":"The metadata key (used as the XML element name when injected into the workstep).","example":"CustomText"},"value":{"type":"string","description":"The metadata value (used as the XML element value when injected into the workstep).","example":"Mario Rossi"}},"additionalProperties":false,"description":"A single recipient metadata entry, expressed as a name/value pair."}},"components/schemas/RecipientSettings":{"id":"components/schemas/RecipientSettings","kind":"json-schema","title":"RecipientSettings","data":{"required":["authentications","mandatoryAuthentication","recipientDelegation","sendCompletedFileToAllRecipients","warnIfRecipientsHaveNoFields"],"type":"object","properties":{"sendCompletedFileToAllRecipients":{"type":"boolean","description":"Whether the completed file is sent to all recipients."},"warnIfRecipientsHaveNoFields":{"type":"boolean","description":"Whether a warning is shown when some recipients have no fields."},"authentications":{"$ref":"#/components/schemas/RecipientAuthenticationSettings"},"recipientDelegation":{"$ref":"#/components/schemas/RecipientDelegation"},"mandatoryAuthentication":{"oneOf":[{"$ref":"#/components/schemas/MandatoryAuthenticationNone"},{"$ref":"#/components/schemas/MandatoryAuthenticationAny"},{"$ref":"#/components/schemas/MandatoryAuthenticationAccessCode"},{"$ref":"#/components/schemas/MandatoryAuthenticationOneTimePassword"},{"$ref":"#/components/schemas/MandatoryAuthenticationOAuth"}],"description":"The organization's mandatory (forced) recipient authentication method."}},"additionalProperties":false,"description":"The organization's recipient settings."}},"components/schemas/RecipientSignatureData":{"id":"components/schemas/RecipientSignatureData","kind":"json-schema","title":"RecipientSignatureData","data":{"type":"object","properties":{"disposableCertificate":{"$ref":"#/components/schemas/DisposableCertificate"},"remoteCertificate":{"$ref":"#/components/schemas/RemoteCertificateDto"},"otpSignature":{"$ref":"#/components/schemas/OtpSignature"},"signingPlugins":{"$ref":"#/components/schemas/SigningPlugins"}},"additionalProperties":false,"description":"Signature configuration for a recipient."}},"components/schemas/RecipientType":{"id":"components/schemas/RecipientType","kind":"json-schema","title":"RecipientType","data":{"enum":["Standard","Automatic"],"type":"string","description":"Possible kinds of recipient"}},"components/schemas/RegionalDefaultsSettings":{"id":"components/schemas/RegionalDefaultsSettings","kind":"json-schema","title":"RegionalDefaultsSettings","data":{"required":["dateTimeFormat","language","timeZone"],"type":"object","properties":{"timeZone":{"type":"string","description":"The organization's default IANA time zone identifier.","example":"Europe/Berlin"},"dateTimeFormat":{"type":"string","description":"The organization's default date and time display format.","example":"dd/MM/yyyy | HH:mm"},"language":{"type":"string","description":"The organization's default language code.","example":"en"}},"additionalProperties":false,"description":"The organization's regional defaults."}},"components/schemas/RelativeBulkEnvelopeExpirationResponse":{"id":"components/schemas/RelativeBulkEnvelopeExpirationResponse","kind":"json-schema","title":"RelativeBulkEnvelopeExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the bulk envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration."}},"components/schemas/RelativeCreateBulkEnvelopeExpiration":{"id":"components/schemas/RelativeCreateBulkEnvelopeExpiration","kind":"json-schema","title":"RelativeCreateBulkEnvelopeExpiration","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the bulk envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration."}},"components/schemas/RelativeCreateEnvelopeExpiration":{"id":"components/schemas/RelativeCreateEnvelopeExpiration","kind":"json-schema","title":"RelativeCreateEnvelopeExpiration","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration.","example":{"afterSendInSeconds":604800,"mode":"Relative"}}},"components/schemas/RelativeCreateTemplateExpiration":{"id":"components/schemas/RelativeCreateTemplateExpiration","kind":"json-schema","title":"RelativeCreateTemplateExpiration","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration.","example":{"afterSendInSeconds":604800,"mode":"Relative"}}},"components/schemas/RelativeEnvelopeExpirationResponse":{"id":"components/schemas/RelativeEnvelopeExpirationResponse","kind":"json-schema","title":"RelativeEnvelopeExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration."}},"components/schemas/RelativeTemplateExpirationResponse":{"id":"components/schemas/RelativeTemplateExpirationResponse","kind":"json-schema","title":"RelativeTemplateExpirationResponse","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration."}},"components/schemas/RelativeUpdateBulkEnvelopeExpirationRequest":{"id":"components/schemas/RelativeUpdateBulkEnvelopeExpirationRequest","kind":"json-schema","title":"RelativeUpdateBulkEnvelopeExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the bulk envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration."}},"components/schemas/RelativeUpdateEnvelopeExpirationRequest":{"id":"components/schemas/RelativeUpdateEnvelopeExpirationRequest","kind":"json-schema","title":"RelativeUpdateEnvelopeExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration.","example":{"afterSendInSeconds":604800,"mode":"Relative"}}},"components/schemas/RelativeUpdateTemplateExpirationRequest":{"id":"components/schemas/RelativeUpdateTemplateExpirationRequest","kind":"json-schema","title":"RelativeUpdateTemplateExpirationRequest","data":{"required":["mode"],"type":"object","properties":{"afterSendInSeconds":{"type":"integer","description":"Seconds after sending before the envelope expires.","format":"int64","nullable":true,"example":604800},"mode":{"enum":["Relative"],"type":"string","default":"Relative"}},"additionalProperties":false,"description":"Relative expiration configuration.","example":{"afterSendInSeconds":604800,"mode":"Relative"}}},"components/schemas/RemoteCertificateDto":{"id":"components/schemas/RemoteCertificateDto","kind":"json-schema","title":"RemoteCertificateDto","data":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID.","nullable":true},"deviceId":{"type":"string","description":"The device ID.","nullable":true}},"additionalProperties":false,"description":"Remote certificate configuration."}},"components/schemas/RemoteCertificateSignature":{"id":"components/schemas/RemoteCertificateSignature","kind":"json-schema","title":"RemoteCertificateSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["RemoteCertificateSignature"],"type":"string","default":"RemoteCertificateSignature"}},"additionalProperties":false,"description":"Remote certificate signature configuration.","example":{"signatureType":"RemoteCertificateSignature"}}},"components/schemas/ResumeEnvelopeRequest":{"id":"components/schemas/ResumeEnvelopeRequest","kind":"json-schema","title":"ResumeEnvelopeRequest","data":{"required":["newExpirationDate"],"type":"object","properties":{"newExpirationDate":{"type":"string","description":"The new expiration date for the resumed envelope.","format":"date-time","example":"2025-12-31T23:59:59Z"}},"additionalProperties":false,"description":"Request body for resuming an expired envelope."}},"components/schemas/SignatureField":{"id":"components/schemas/SignatureField","kind":"json-schema","title":"SignatureField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"allowedSignatureTypes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ClickToSignSignature"},{"$ref":"#/components/schemas/DrawToSignSignature"},{"$ref":"#/components/schemas/TypeToSignSignature"},{"$ref":"#/components/schemas/LocalCertificateSignature"},{"$ref":"#/components/schemas/DisposableCertificateSignature"},{"$ref":"#/components/schemas/BiometricSignature"},{"$ref":"#/components/schemas/RemoteCertificateSignature"},{"$ref":"#/components/schemas/OneTimePasswordSignature"},{"$ref":"#/components/schemas/PluginSignature"},{"$ref":"#/components/schemas/AutomaticSignature"}],"description":"Base signature type configuration."},"description":"The allowed signature types for this field.","nullable":true},"qualifiedTimeStamp":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the signature must use a qualified timestamp server. Optional. When omitted, the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied at the downstream Nova boundary."},"children":[]}]}]}],"nullable":true,"example":true},"required":{"type":"boolean","description":"Whether the field is required."},"batchGroup":{"type":"string","description":"The optional batch-signing group this field belongs to.","nullable":true,"example":"group1"},"layoutId":{"type":"string","description":"The optional identifier of the signature layout applied to this field, one of the organization's signature layouts. When omitted, the organization default layout is used.","format":"uuid","nullable":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["Signature"],"type":"string","default":"Signature"}},"description":"A signature field.","example":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"BiometricSignature"},{"signatureType":"ClickToSignSignature"},{"signatureType":"DisposableCertificateSignature"},{"signatureType":"DrawToSignSignature"},{"signatureType":"LocalCertificateSignature"},{"signatureType":"OneTimePasswordSignature"},{"signatureType":"PluginSignature","pluginId":"ArubaGsp"},{"signatureType":"RemoteCertificateSignature"},{"signatureType":"TypeToSignSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"}}},"components/schemas/SignatureFormat":{"id":"components/schemas/SignatureFormat","kind":"json-schema","title":"SignatureFormat","data":{"enum":["Pades","Cades"],"type":"string","description":"The signature format for an envelope or template."}},"components/schemas/SignatureLayout":{"id":"components/schemas/SignatureLayout","kind":"json-schema","title":"SignatureLayout","data":{"required":["fields","id","name"],"type":"object","properties":{"id":{"type":"string","description":"The signature layout identifier.","format":"uuid"},"name":{"type":"string","description":"The unique name of the signature layout."},"fields":{"$ref":"#/components/schemas/SignatureLayoutFields"},"image":{"$ref":"#/components/schemas/SignatureLayoutImage"}},"additionalProperties":false,"description":"A signature layout of an organization."}},"components/schemas/SignatureLayoutDateTimeField":{"id":"components/schemas/SignatureLayoutDateTimeField","kind":"json-schema","title":"SignatureLayoutDateTimeField","data":{"required":["localTimezone","visible"],"type":"object","properties":{"visible":{"type":"boolean","description":"Whether the row is shown."},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time format: a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by GET /api/v1/datetime-formats."},"children":[]}]}]}],"nullable":true},"localTimezone":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the date and time are shown in the signer's local timezone. When true, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null."},"children":[]}]}]}]},"timezone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IANA timezone used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localTimezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false: a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by GET /api/v1/timezones."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"The date and time row of the signature appearance."}},"components/schemas/SignatureLayoutDateTimeFieldRequest":{"id":"components/schemas/SignatureLayoutDateTimeFieldRequest","kind":"json-schema","title":"SignatureLayoutDateTimeFieldRequest","data":{"required":["visible"],"type":"object","properties":{"visible":{"type":"boolean","description":"Whether the row is shown."},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time format: exactly one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values returned by GET /api/v1/datetime-formats. Required when the row is visible."},"children":[]}]}]}],"nullable":true},"localTimezone":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the date and time are shown in the signer's local timezone. Required when the row is visible. When true, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be omitted."},"children":[]}]}]}],"nullable":true},"timezone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IANA timezone: exactly one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values returned by GET /api/v1/timezones. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localTimezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"The date and time row of the signature appearance."}},"components/schemas/SignatureLayoutField":{"id":"components/schemas/SignatureLayoutField","kind":"json-schema","title":"SignatureLayoutField","data":{"required":["visible"],"type":"object","properties":{"visible":{"type":"boolean","description":"Whether the row is shown."}},"additionalProperties":false,"description":"A row of the signature appearance."}},"components/schemas/SignatureLayoutFields":{"id":"components/schemas/SignatureLayoutFields","kind":"json-schema","title":"SignatureLayoutFields","data":{"required":["customText","dateTime","ipAddress","reason","signerEmail","signerName"],"type":"object","properties":{"signerName":{"$ref":"#/components/schemas/SignatureLayoutField"},"signerEmail":{"$ref":"#/components/schemas/SignatureLayoutField"},"ipAddress":{"$ref":"#/components/schemas/SignatureLayoutField"},"reason":{"$ref":"#/components/schemas/SignatureLayoutField"},"dateTime":{"$ref":"#/components/schemas/SignatureLayoutDateTimeField"},"customText":{"$ref":"#/components/schemas/SignatureLayoutField"}},"additionalProperties":false,"description":"The configuration of the fields shown in the signature appearance."}},"components/schemas/SignatureLayoutFieldsRequest":{"id":"components/schemas/SignatureLayoutFieldsRequest","kind":"json-schema","title":"SignatureLayoutFieldsRequest","data":{"required":["customText","dateTime","ipAddress","reason","signerEmail","signerName"],"type":"object","properties":{"signerName":{"$ref":"#/components/schemas/SignatureLayoutField"},"signerEmail":{"$ref":"#/components/schemas/SignatureLayoutField"},"ipAddress":{"$ref":"#/components/schemas/SignatureLayoutField"},"reason":{"$ref":"#/components/schemas/SignatureLayoutField"},"dateTime":{"$ref":"#/components/schemas/SignatureLayoutDateTimeFieldRequest"},"customText":{"$ref":"#/components/schemas/SignatureLayoutField"}},"additionalProperties":false,"description":"The configuration of the fields shown in the signature appearance."}},"components/schemas/SignatureLayoutImage":{"id":"components/schemas/SignatureLayoutImage","kind":"json-schema","title":"SignatureLayoutImage","data":{"required":["dataBase64","mimeType","position"],"type":"object","properties":{"mimeType":{"type":"string","description":"The MIME type: image/png, image/jpeg, image/gif or image/webp."},"dataBase64":{"type":"string","description":"The base64 encoded image, up to 716800 characters (about 512 KB)."},"position":{"$ref":"#/components/schemas/SignatureLayoutImagePosition"}},"additionalProperties":false,"description":"The image of the signature appearance."}},"components/schemas/SignatureLayoutImagePosition":{"id":"components/schemas/SignatureLayoutImagePosition","kind":"json-schema","title":"SignatureLayoutImagePosition","data":{"enum":["Background","Above","Below","Left","Right"],"type":"string","description":"The position of the image relative to the signature text."}},"components/schemas/SignatureLayoutListResponse":{"id":"components/schemas/SignatureLayoutListResponse","kind":"json-schema","title":"SignatureLayoutListResponse","data":{"required":["layouts"],"type":"object","properties":{"layouts":{"type":"array","items":{"$ref":"#/components/schemas/SignatureLayoutSummary"},"description":"The signature layouts."}},"additionalProperties":false,"description":"List of the signature layouts of an organization."}},"components/schemas/SignatureLayoutRequest":{"id":"components/schemas/SignatureLayoutRequest","kind":"json-schema","title":"SignatureLayoutRequest","data":{"required":["fields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name: 1-50 letters, digits or hyphens, not starting or ending with a hyphen. Unique within the organization. \"default\" is reserved."},"fields":{"$ref":"#/components/schemas/SignatureLayoutFieldsRequest"},"image":{"$ref":"#/components/schemas/SignatureLayoutImage"}},"additionalProperties":false,"description":"The body used to create or replace a signature layout."}},"components/schemas/SignatureLayoutSummary":{"id":"components/schemas/SignatureLayoutSummary","kind":"json-schema","title":"SignatureLayoutSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The signature layout identifier.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The name of the signature layout.","example":"Default layout"}},"additionalProperties":false,"description":"Summary representation of a signature layout."}},"components/schemas/SignatureSettings":{"id":"components/schemas/SignatureSettings","kind":"json-schema","title":"SignatureSettings","data":{"required":["auditTrailMode","defaultSignatureType","timestamp"],"type":"object","properties":{"defaultSignatureType":{"$ref":"#/components/schemas/DefaultSignatureType"},"auditTrailMode":{"$ref":"#/components/schemas/AuditTrailMode"},"timestamp":{"$ref":"#/components/schemas/SignatureSettingsTimestamp"},"disposableCertificate":{"$ref":"#/components/schemas/SignatureSettingsDisposableCertificate"},"defaultSignatureLayoutId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the organization's default signature layout, readable with GET /api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}. Read-only. Null until the organization's signature layouts have been read for the first time."},"children":[]}]}]}],"format":"uuid","nullable":true}},"additionalProperties":false,"description":"The organization's signature settings."}},"components/schemas/SignatureSettingsDisposableCertificate":{"id":"components/schemas/SignatureSettingsDisposableCertificate","kind":"json-schema","title":"SignatureSettingsDisposableCertificate","data":{"required":["sendDisposableDisclaimerDocumentNotifications","showDisclaimerBeforeCertificateRequest"],"type":"object","properties":{"showDisclaimerBeforeCertificateRequest":{"type":"boolean","description":"Whether the disclaimer is shown before requesting the certificate."},"sendDisposableDisclaimerDocumentNotifications":{"type":"boolean","description":"Whether disclaimer document notifications are sent."},"lraId":{"type":"string","description":"The LRA identifier.","nullable":true},"user":{"type":"string","description":"The user identifier.","nullable":true},"disposableType":{"$ref":"#/components/schemas/DisposableCertificateType"}},"additionalProperties":false,"description":"The organization's disposable certificate configuration, excluding the password."}},"components/schemas/SignatureSettingsTimestamp":{"id":"components/schemas/SignatureSettingsTimestamp","kind":"json-schema","title":"SignatureSettingsTimestamp","data":{"required":["hashAlgorithm"],"type":"object","properties":{"url":{"type":"string","description":"The timestamp server URL.","nullable":true},"username":{"type":"string","description":"The timestamp server username.","nullable":true},"hashAlgorithm":{"$ref":"#/components/schemas/TimestampHashAlgorithm"}},"additionalProperties":false,"description":"The organization's timestamp server configuration, excluding the password."}},"components/schemas/SignatureType":{"id":"components/schemas/SignatureType","kind":"json-schema","title":"SignatureType","data":{"enum":["ClickToSignSignature","DrawToSignSignature","TypeToSignSignature","LocalCertificateSignature","DisposableCertificateSignature","BiometricSignature","RemoteCertificateSignature","OneTimePasswordSignature","PluginSignature","AutomaticSignature"],"type":"string","description":"The available signature types."}},"components/schemas/SigningPlugin":{"id":"components/schemas/SigningPlugin","kind":"json-schema","title":"SigningPlugin","data":{"type":"object","properties":{"pluginId":{"type":"string","description":"The plugin ID.","nullable":true},"settings":{"type":"array","items":{"$ref":"#/components/schemas/SigningPluginSetting"},"description":"The plugin settings.","nullable":true}},"additionalProperties":false,"description":"A signing plugin."}},"components/schemas/SigningPluginSetting":{"id":"components/schemas/SigningPluginSetting","kind":"json-schema","title":"SigningPluginSetting","data":{"type":"object","properties":{"key":{"type":"string","description":"The setting key.","nullable":true},"value":{"type":"string","description":"The setting value.","nullable":true}},"additionalProperties":false,"description":"A signing plugin setting."}},"components/schemas/SigningPlugins":{"id":"components/schemas/SigningPlugins","kind":"json-schema","title":"SigningPlugins","data":{"type":"object","properties":{"plugins":{"type":"array","items":{"$ref":"#/components/schemas/SigningPlugin"},"description":"The list of signing plugins.","nullable":true}},"additionalProperties":false,"description":"Signing plugins configuration."}},"components/schemas/StageConfigurationRequest":{"id":"components/schemas/StageConfigurationRequest","kind":"json-schema","title":"StageConfigurationRequest","data":{"required":["name","requiredRecipientCompletions","type"],"type":"object","properties":{"name":{"type":"string","description":"The stage name."},"type":{"$ref":"#/components/schemas/StageType"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1}},"additionalProperties":false,"description":"The stage configuration applied by a policy action."}},"components/schemas/StageConfigurationResponse":{"id":"components/schemas/StageConfigurationResponse","kind":"json-schema","title":"StageConfigurationResponse","data":{"required":["name","requiredRecipientCompletions","type"],"type":"object","properties":{"name":{"type":"string","description":"The stage name."},"type":{"$ref":"#/components/schemas/StageType"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1}},"additionalProperties":false,"description":"The stage configuration applied by a policy action."}},"components/schemas/StageMode":{"id":"components/schemas/StageMode","kind":"json-schema","title":"StageMode","data":{"enum":["Standard","Bulk"],"type":"string","description":"The mode of a stage, indicating whether it is a standard or bulk signing stage."}},"components/schemas/StageType":{"id":"components/schemas/StageType","kind":"json-schema","title":"StageType","data":{"enum":["Signer","CarbonCopy","Viewer","Automatic","Approver"],"type":"string","description":"The type of a stage, derived from recipient types."}},"components/schemas/StaticPolicyRecipientSourceRequest":{"id":"components/schemas/StaticPolicyRecipientSourceRequest","kind":"json-schema","title":"StaticPolicyRecipientSourceRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyRecipientSourceRequest"},{"type":"object","properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/PolicyRecipientRequest"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fixed list of recipients. Required, and used only when Modules.DocumentClasses.Core.Models.StaticPolicyRecipientSourceRequest.Type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Static"],"type":"string","default":"Static"}},"description":"Recipients are a fixed list."}},"components/schemas/StaticPolicyRecipientSourceResponse":{"id":"components/schemas/StaticPolicyRecipientSourceResponse","kind":"json-schema","title":"StaticPolicyRecipientSourceResponse","data":{"required":["recipients","type"],"type":"object","properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/PolicyRecipientResponse"},"description":"The fixed list of recipients."},"type":{"enum":["Static"],"type":"string","default":"Static"}},"additionalProperties":false,"description":"A policy action's recipient source resolved from a fixed list of recipients."}},"components/schemas/StringDocumentClassMetadataResponse":{"id":"components/schemas/StringDocumentClassMetadataResponse","kind":"json-schema","title":"StringDocumentClassMetadataResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentClassMetadataResponse"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":"A document class metadata field carrying a text value.","example":{"type":"StringType","id":"01097059-216b-4ec9-af09-08f424ec7185","name":"SignerName","required":true,"sortOrder":1}}},"components/schemas/StringDocumentMetadataItem":{"id":"components/schemas/StringDocumentMetadataItem","kind":"json-schema","title":"StringDocumentMetadataItem","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/DocumentMetadataItem"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization-level document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.StringType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"StringType","id":"f054f685-3468-4cc1-a44f-b8c9daf4a57a","name":"ContractNumber"}}},"components/schemas/StringFileMetadataValueResponse":{"id":"components/schemas/StringFileMetadataValueResponse","kind":"json-schema","title":"StringFileMetadataValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/FileMetadataValueResponse"},{"type":"object","properties":{"value":{"type":"string","description":"The text value, or null if not set.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":"A text metadata value of a file.","example":{"value":"New contract","type":"StringType","id":"febedd76-d043-42c2-b1cf-57467fb8c38c","name":"Title"}}},"components/schemas/StringInputConfig":{"id":"components/schemas/StringInputConfig","kind":"json-schema","title":"StringInputConfig","data":{"required":["maxLength","multiline","password","textInputType","value"],"type":"object","properties":{"textInputType":{"enum":["StringType"],"type":"string","default":"StringType"},"value":{"type":"string","description":"The text value."},"password":{"type":"boolean","description":"Whether the field is a password field."},"multiline":{"type":"boolean","description":"Whether the field allows multiline input."},"maxLength":{"type":"integer","description":"The maximum length of the text.","format":"int32"}},"additionalProperties":false,"description":"Configuration for a string text input.","example":{"textInputType":"StringType","value":"Default text","password":false,"multiline":false,"maxLength":100}}},"components/schemas/StringMetadataValueRequest":{"id":"components/schemas/StringMetadataValueRequest","kind":"json-schema","title":"StringMetadataValueRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/MetadataValueRequest"},{"type":"object","properties":{"value":{"type":"string","description":"The string value.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":"A metadata value carrying a text payload."}},"components/schemas/StringOptional":{"id":"components/schemas/StringOptional","kind":"json-schema","title":"StringOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"type":"string","readOnly":true}},"additionalProperties":false}},"components/schemas/StringOptionalNullable":{"id":"components/schemas/StringOptionalNullable","kind":"json-schema","title":"StringOptionalNullable","data":{"required":["isSet"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}},"components/schemas/StringPolicyConditionMetadataRequest":{"id":"components/schemas/StringPolicyConditionMetadataRequest","kind":"json-schema","title":"StringPolicyConditionMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataRequest"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison text value.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":"A policy condition's comparison value for a string-type metadata field."}},"components/schemas/StringPolicyConditionValueResponse":{"id":"components/schemas/StringPolicyConditionValueResponse","kind":"json-schema","title":"StringPolicyConditionValueResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/PolicyConditionMetadataResponse"},{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The comparison text value.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":"A policy condition's comparison value for a string-type metadata field."}},"components/schemas/SymbolPosition":{"id":"components/schemas/SymbolPosition","kind":"json-schema","title":"SymbolPosition","data":{"enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string","description":"The position of the symbol relative to a number value."}},"components/schemas/TemplateAutomaticRecipientResponse":{"id":"components/schemas/TemplateAutomaticRecipientResponse","kind":"json-schema","title":"TemplateAutomaticRecipientResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/TemplateRecipientResponse"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile used for automatic signing.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Detailed representation of an Automatic recipient.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","id":"00000000-0000-0000-0000-000000000100","languageCode":"en-US"}}},"components/schemas/TemplateFileDetailResponse":{"id":"components/schemas/TemplateFileDetailResponse","kind":"json-schema","title":"TemplateFileDetailResponse","data":{"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/TemplateFileDocumentClassResponse"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file, or null if not set.","nullable":true}},"additionalProperties":false,"description":"Response containing details of a template file."}},"components/schemas/TemplateFileDocumentClassResponse":{"id":"components/schemas/TemplateFileDocumentClassResponse","kind":"json-schema","title":"TemplateFileDocumentClassResponse","data":{"required":["id","metadata"],"type":"object","properties":{"id":{"type":"string","description":"The assigned document class ID.","format":"uuid"},"name":{"type":"string","description":"The document class name, or null if none is assigned.","nullable":true},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringFileMetadataValueResponse"},{"$ref":"#/components/schemas/NumberFileMetadataValueResponse"},{"$ref":"#/components/schemas/DateFileMetadataValueResponse"},{"$ref":"#/components/schemas/ListOptionFileMetadataValueResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value of a file. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata field values for this file."}},"additionalProperties":false,"description":"Response containing the document class assigned to a template file."}},"components/schemas/TemplateFileListResponse":{"id":"components/schemas/TemplateFileListResponse","kind":"json-schema","title":"TemplateFileListResponse","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFileResponse"},"description":"The list of files."}},"additionalProperties":false,"description":"List of files."}},"components/schemas/TemplateFileResponse":{"id":"components/schemas/TemplateFileResponse","kind":"json-schema","title":"TemplateFileResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid"},"name":{"type":"string","description":"The file name."},"sortOrder":{"type":"integer","description":"The position of the file in the sequence.","format":"int32"}},"additionalProperties":false,"description":"Representation of a file."}},"components/schemas/TemplateFileSummaryResponse":{"id":"components/schemas/TemplateFileSummaryResponse","kind":"json-schema","title":"TemplateFileSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The file ID.","format":"uuid"},"name":{"type":"string","description":"The file name."},"sortOrder":{"type":"integer","description":"The file sort order.","format":"int32"}},"additionalProperties":false,"description":"Summary of a template file."}},"components/schemas/TemplateListResponse":{"id":"components/schemas/TemplateListResponse","kind":"json-schema","title":"TemplateListResponse","data":{"required":["pagination","templates"],"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"},"description":"The list of templates."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of templates."}},"components/schemas/TemplateRecipientResponse":{"id":"components/schemas/TemplateRecipientResponse","kind":"json-schema","title":"TemplateRecipientResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid"},"languageCode":{"type":"string","description":"The language code for the recipient's notifications.","nullable":true}},"additionalProperties":false,"description":"Detailed representation of a recipient. Base for polymorphic response."}},"components/schemas/TemplateReminderResponse":{"id":"components/schemas/TemplateReminderResponse","kind":"json-schema","title":"TemplateReminderResponse","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled."},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32"},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32"},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32"}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/TemplateResponse":{"id":"components/schemas/TemplateResponse","kind":"json-schema","title":"TemplateResponse","data":{"required":["createdAt","fileRestrictedVisibility","files","id","qualifiedTimeStamp","signatureFormat","stages","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The template ID.","format":"uuid"},"name":{"type":"string","description":"The template name.","nullable":true},"createdAt":{"type":"string","description":"When the template was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the template was last updated.","format":"date-time"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteTemplateExpirationResponse"},{"$ref":"#/components/schemas/RelativeTemplateExpirationResponse"},{"enum":[null],"nullable":true}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/TemplateReminderResponse"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStageSummaryResponse"},"description":"The stages of the template."},"files":{"type":"array","items":{"$ref":"#/components/schemas/TemplateFileSummaryResponse"},"description":"The files of the template."},"qualifiedTimeStamp":{"type":"boolean","description":"Whether all signatures in the template must use a qualified timestamp server.","example":true},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"signatureReason":{"type":"string","description":"The signature reason persisted on the template, or null.","nullable":true,"example":"Approved by Mario Rossi"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language, or null when no custom agreements are configured.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient.","example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope.","nullable":true,"example":"https://example.com/envelope-sent"}},"additionalProperties":false,"description":"Detailed representation of a template."}},"components/schemas/TemplateStageAutomaticRecipientSummary":{"id":"components/schemas/TemplateStageAutomaticRecipientSummary","kind":"json-schema","title":"TemplateStageAutomaticRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/TemplateStageRecipientSummary"},{"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile used for automatic signing.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Stage summary for an Automatic recipient."}},"components/schemas/TemplateStageListResponse":{"id":"components/schemas/TemplateStageListResponse","kind":"json-schema","title":"TemplateStageListResponse","data":{"required":["stages"],"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStageSummary"},"description":"The list of stages."}},"additionalProperties":false,"description":"List of stages."}},"components/schemas/TemplateStageRecipientSummary":{"id":"components/schemas/TemplateStageRecipientSummary","kind":"json-schema","title":"TemplateStageRecipientSummary","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The recipient ID.","format":"uuid"}},"additionalProperties":false,"description":"Summary representation of a stage recipient. Base for polymorphic response."}},"components/schemas/TemplateStageResponse":{"id":"components/schemas/TemplateStageResponse","kind":"json-schema","title":"TemplateStageResponse","data":{"required":["id","name","recipients","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid"},"name":{"type":"string","description":"The stage name."},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32"},"type":{"$ref":"#/components/schemas/StageType"},"recipients":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TemplateStageStandardRecipientSummary"},{"$ref":"#/components/schemas/TemplateStageAutomaticRecipientSummary"}],"description":"Summary representation of a stage recipient. Base for polymorphic response."},"description":"The recipients of the stage."}},"additionalProperties":false,"description":"Detailed representation of a stage."}},"components/schemas/TemplateStageSortOrder":{"id":"components/schemas/TemplateStageSortOrder","kind":"json-schema","title":"TemplateStageSortOrder","data":{"required":["id","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid"},"sortOrder":{"type":"integer","description":"The new position of the stage.","format":"int32"}},"additionalProperties":false,"description":"Sort order entry for a stage."}},"components/schemas/TemplateStageStandardRecipientSummary":{"id":"components/schemas/TemplateStageStandardRecipientSummary","kind":"json-schema","title":"TemplateStageStandardRecipientSummary","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/TemplateStageRecipientSummary"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true},"surname":{"type":"string","description":"The recipient's last name.","nullable":true},"email":{"type":"string","description":"The recipient's email address.","nullable":true},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Stage summary for a Recipient recipient."}},"components/schemas/TemplateStageSummary":{"id":"components/schemas/TemplateStageSummary","kind":"json-schema","title":"TemplateStageSummary","data":{"required":["id","name","requiredRecipientCompletions","sortOrder","type"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid"},"name":{"type":"string","description":"The stage name."},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32"},"type":{"$ref":"#/components/schemas/StageType"}},"additionalProperties":false,"description":"Summary representation of a stage."}},"components/schemas/TemplateStageSummaryResponse":{"id":"components/schemas/TemplateStageSummaryResponse","kind":"json-schema","title":"TemplateStageSummaryResponse","data":{"required":["id","name","sortOrder"],"type":"object","properties":{"id":{"type":"string","description":"The stage ID.","format":"uuid"},"name":{"type":"string","description":"The stage name."},"sortOrder":{"type":"integer","description":"The position of the stage in the sequence.","format":"int32"}},"additionalProperties":false,"description":"Stage summary within a template response."}},"components/schemas/TemplateStandardRecipientResponse":{"id":"components/schemas/TemplateStandardRecipientResponse","kind":"json-schema","title":"TemplateStandardRecipientResponse","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/TemplateRecipientResponse"},{"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true},"surname":{"type":"string","description":"The recipient's last name.","nullable":true},"email":{"type":"string","description":"The recipient's email address.","nullable":true},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/RecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/RecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Detailed representation of a Recipient recipient.","example":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached document.","id":"00000000-0000-0000-0000-000000000100","languageCode":"en-US"}}},"components/schemas/TemplateSummary":{"id":"components/schemas/TemplateSummary","kind":"json-schema","title":"TemplateSummary","data":{"required":["createdAt","id","name","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The template ID.","format":"uuid"},"name":{"type":"string","description":"The template name."},"createdAt":{"type":"string","description":"When the template was created.","format":"date-time"},"updatedAt":{"type":"string","description":"When the template was last updated.","format":"date-time"}},"additionalProperties":false,"description":"Summary representation of a template."}},"components/schemas/TextAlign":{"id":"components/schemas/TextAlign","kind":"json-schema","title":"TextAlign","data":{"enum":["Left","Center","Right"],"type":"string","description":"Text alignment options."}},"components/schemas/TextAnnotationValueFormat":{"id":"components/schemas/TextAnnotationValueFormat","kind":"json-schema","title":"TextAnnotationValueFormat","data":{"required":["annotationType"],"type":"object","properties":{"annotationType":{"enum":["Text"],"type":"string","default":"Text"},"value":{"type":"string","description":"The default value for the text annotation.","nullable":true}},"additionalProperties":false,"description":"Free text annotation value format."}},"components/schemas/TextInputField":{"id":"components/schemas/TextInputField","kind":"json-schema","title":"TextInputField","data":{"required":["fieldType"],"allOf":[{"$ref":"#/components/schemas/BaseField"},{"required":["textInputConfig"],"type":"object","properties":{"page":{"type":"integer","description":"The page number where the field is placed.","format":"int32"},"positionX":{"type":"number","description":"The horizontal position of the field on the page.","format":"double"},"positionY":{"type":"number","description":"The vertical position of the field on the page.","format":"double"},"width":{"type":"number","description":"The width of the field.","format":"double"},"height":{"type":"number","description":"The height of the field.","format":"double"},"font":{"$ref":"#/components/schemas/FontStyle"},"textInputConfig":{"oneOf":[{"$ref":"#/components/schemas/StringInputConfig"},{"$ref":"#/components/schemas/DateInputConfig"},{"$ref":"#/components/schemas/NumberInputConfig"},{"$ref":"#/components/schemas/PhoneNumberInputConfig"},{"$ref":"#/components/schemas/TimeInputConfig"},{"enum":[null],"nullable":true}],"description":"The text input configuration."},"readOnly":{"type":"boolean","description":"Whether the field is read-only."},"required":{"type":"boolean","description":"Whether the field is required."}},"additionalProperties":false}],"properties":{"fieldType":{"enum":["TextInput"],"type":"string","default":"TextInput"}},"description":"A text input field with font and input configuration.","example":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"StringType","value":"Default text","password":false,"multiline":false,"maxLength":100},"readOnly":false,"required":false,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"}}},"components/schemas/TextInputType":{"id":"components/schemas/TextInputType","kind":"json-schema","title":"TextInputType","data":{"enum":["StringType","DateType","NumberType","PhoneNumberType","TimeType"],"type":"string","description":"The type of text input."}},"components/schemas/ThousandsSeparator":{"id":"components/schemas/ThousandsSeparator","kind":"json-schema","title":"ThousandsSeparator","data":{"enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string","description":"The thousands separator used by a number text input."}},"components/schemas/TimeFormat":{"id":"components/schemas/TimeFormat","kind":"json-schema","title":"TimeFormat","data":{"enum":["HH:mm"],"type":"string","description":"Available time display formats for a time text input."}},"components/schemas/TimeInputConfig":{"id":"components/schemas/TimeInputConfig","kind":"json-schema","title":"TimeInputConfig","data":{"required":["format","textInputType"],"type":"object","properties":{"textInputType":{"enum":["TimeType"],"type":"string","default":"TimeType"},"value":{"type":"string","description":"The time value.","format":"time","nullable":true},"format":{"$ref":"#/components/schemas/TimeFormat"},"minValue":{"type":"string","description":"The minimum allowed time.","format":"time","nullable":true},"maxValue":{"type":"string","description":"The maximum allowed time.","format":"time","nullable":true}},"additionalProperties":false,"description":"Configuration for a time text input.","example":{"textInputType":"TimeType","value":"14:30:00","format":"HH:mm","minValue":"08:00:00","maxValue":"18:00:00"}}},"components/schemas/TimeZoneListResponse":{"id":"components/schemas/TimeZoneListResponse","kind":"json-schema","title":"TimeZoneListResponse","data":{"required":["timeZones"],"type":"object","properties":{"timeZones":{"type":"array","items":{"$ref":"#/components/schemas/TimeZoneResponse"},"description":"The list of time zones."}},"additionalProperties":false,"description":"List of available time zones."}},"components/schemas/TimeZoneResponse":{"id":"components/schemas/TimeZoneResponse","kind":"json-schema","title":"TimeZoneResponse","data":{"required":["code","name"],"type":"object","properties":{"code":{"type":"string","description":"The IANA time zone identifier.","example":"Europe/Berlin"},"name":{"type":"string","description":"The display name of the time zone.","example":"(UTC+01:00) Berlin"}},"additionalProperties":false,"description":"A time zone available for selection."}},"components/schemas/TimestampHashAlgorithm":{"id":"components/schemas/TimestampHashAlgorithm","kind":"json-schema","title":"TimestampHashAlgorithm","data":{"enum":["SHA-1","SHA-256","SHA-512"],"type":"string","description":"The hash algorithms supported by a timestamp server configuration."}},"components/schemas/TimestampHashAlgorithmOptional":{"id":"components/schemas/TimestampHashAlgorithmOptional","kind":"json-schema","title":"TimestampHashAlgorithmOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/TimestampHashAlgorithm"}},"additionalProperties":false}},"components/schemas/TypeToSignSignature":{"id":"components/schemas/TypeToSignSignature","kind":"json-schema","title":"TypeToSignSignature","data":{"required":["signatureType"],"type":"object","properties":{"signatureType":{"enum":["TypeToSignSignature"],"type":"string","default":"TypeToSignSignature"}},"additionalProperties":false,"description":"Type to sign signature configuration.","example":{"signatureType":"TypeToSignSignature"}}},"components/schemas/UpdateAccessCode":{"id":"components/schemas/UpdateAccessCode","kind":"json-schema","title":"UpdateAccessCode","data":{"type":"object","properties":{"code":{"type":"string","description":"The access code.","nullable":true}},"additionalProperties":false,"description":"Access code configuration for update."}},"components/schemas/UpdateApplicationRoleRequest":{"id":"components/schemas/UpdateApplicationRoleRequest","kind":"json-schema","title":"UpdateApplicationRoleRequest","data":{"required":["name","permissions"],"type":"object","properties":{"name":{"type":"string","description":"The application role name.","example":"Contract Reviewer"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"},"description":"The entity/action permission pairs granted by the application role."},"description":{"type":"string","description":"The application role description.","nullable":true,"example":"Can read envelopes"}},"additionalProperties":false,"description":"Request body for updating an application role."}},"components/schemas/UpdateAuthenticationOneTimePassword":{"id":"components/schemas/UpdateAuthenticationOneTimePassword","kind":"json-schema","title":"UpdateAuthenticationOneTimePassword","data":{"required":["channel"],"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OneTimePasswordAuthenticationChannel"}},"additionalProperties":false,"description":"OTP authentication configuration for update."}},"components/schemas/UpdateBulkEnvelopeFileDetailRequest":{"id":"components/schemas/UpdateBulkEnvelopeFileDetailRequest","kind":"json-schema","title":"UpdateBulkEnvelopeFileDetailRequest","data":{"required":["documentClass"],"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/UpdateBulkEnvelopeFileDocumentClassRequest"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file. Null means no change.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the details of a bulk envelope file."}},"components/schemas/UpdateBulkEnvelopeFileDocumentClassRequest":{"id":"components/schemas/UpdateBulkEnvelopeFileDocumentClassRequest","kind":"json-schema","title":"UpdateBulkEnvelopeFileDocumentClassRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The document class identifier.","format":"uuid"},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringMetadataValueRequest"},{"$ref":"#/components/schemas/NumberMetadataValueRequest"},{"$ref":"#/components/schemas/DateMetadataValueRequest"},{"$ref":"#/components/schemas/ListOptionMetadataValueRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata values to assign.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the document class of a bulk envelope file."}},"components/schemas/UpdateBulkEnvelopeFileTasksRequest":{"id":"components/schemas/UpdateBulkEnvelopeFileTasksRequest","kind":"json-schema","title":"UpdateBulkEnvelopeFileTasksRequest","data":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/BulkEnvelopeFieldTaskRequest"},"description":"The complete list of tasks for the file."}},"additionalProperties":false,"description":"Request body for replacing the field tasks of a bulk-envelope file."}},"components/schemas/UpdateBulkEnvelopeReminderRequest":{"id":"components/schemas/UpdateBulkEnvelopeReminderRequest","kind":"json-schema","title":"UpdateBulkEnvelopeReminderRequest","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/UpdateBulkEnvelopeRequest":{"id":"components/schemas/UpdateBulkEnvelopeRequest","kind":"json-schema","title":"UpdateBulkEnvelopeRequest","data":{"required":["expiration","name","reminder"],"type":"object","properties":{"name":{"type":"string","description":"The bulk envelope name.","example":"Updated bulk contract name"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteUpdateBulkEnvelopeExpirationRequest"},{"$ref":"#/components/schemas/RelativeUpdateBulkEnvelopeExpirationRequest"}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/UpdateBulkEnvelopeReminderRequest"},"qualifiedTimeStamp":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether all signatures in the bulk envelope must use a qualified timestamp server. Optional. When omitted, the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied at the downstream Nova boundary."},"children":[]}]}]}],"nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the bulk envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient. Null means no change.","nullable":true,"example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the bulk envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"https://example.com/bulk-envelope-sent"}},"additionalProperties":false,"description":"Request body for updating a bulk envelope."}},"components/schemas/UpdateBulkEnvelopeStageAutomaticRecipientRequest":{"id":"components/schemas/UpdateBulkEnvelopeStageAutomaticRecipientRequest","kind":"json-schema","title":"UpdateBulkEnvelopeStageAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateBulkEnvelopeStageRecipientRequest"},{"required":["signatureProfile"],"type":"object","properties":{"signatureProfile":{"type":"string","description":"Signature profile name for the automatic recipient.","nullable":true,"example":"default-eseal-profile"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request to update an automatic recipient on a bulk envelope stage.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/UpdateBulkEnvelopeStageRecipientRequest":{"id":"components/schemas/UpdateBulkEnvelopeStageRecipientRequest","kind":"json-schema","title":"UpdateBulkEnvelopeStageRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update bulk envelope stage recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/UpdateBulkEnvelopeStageRequest":{"id":"components/schemas/UpdateBulkEnvelopeStageRequest","kind":"json-schema","title":"UpdateBulkEnvelopeStageRequest","data":{"required":["name","requiredRecipientCompletions","type"],"type":"object","properties":{"name":{"type":"string","description":"The stage name.","example":"Updated Stage Name"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"}},"additionalProperties":false,"description":"Request body for updating a bulk envelope stage."}},"components/schemas/UpdateBulkEnvelopeStageStandardRecipientRequest":{"id":"components/schemas/UpdateBulkEnvelopeStageStandardRecipientRequest","kind":"json-schema","title":"UpdateBulkEnvelopeStageStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateBulkEnvelopeStageRecipientRequest"},{"required":["email","givenName","notificationChannels","phoneNumber","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/UpdateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/UpdateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for updating a Standard recipient on a bulk envelope stage."}},"components/schemas/UpdateBusinessRoleRequest":{"id":"components/schemas/UpdateBusinessRoleRequest","kind":"json-schema","title":"UpdateBusinessRoleRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The business role name.","example":"Approver"},"description":{"type":"string","description":"The optional business role description. Omitted or null clears the description.","nullable":true,"example":"Approves envelopes before completion."}},"additionalProperties":false,"description":"Request body for updating a business role."}},"components/schemas/UpdateDateDocumentMetadataRequest":{"id":"components/schemas/UpdateDateDocumentMetadataRequest","kind":"json-schema","title":"UpdateDateDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["DateType"],"type":"string","default":"DateType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.DateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"DateType","name":"SignatureDate"}}},"components/schemas/UpdateDisposableCertificate":{"id":"components/schemas/UpdateDisposableCertificate","kind":"json-schema","title":"UpdateDisposableCertificate","data":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/UpdateDisposableCertificateDocument"},"identification":{"$ref":"#/components/schemas/UpdateDisposableCertificateIdentification"},"verificationPhoneNumber":{"type":"string","description":"The phone number for verification.","nullable":true}},"additionalProperties":false,"description":"Disposable certificate configuration for update."}},"components/schemas/UpdateDisposableCertificateDocument":{"id":"components/schemas/UpdateDisposableCertificateDocument","kind":"json-schema","title":"UpdateDisposableCertificateDocument","data":{"type":"object","properties":{"type":{"type":"string","description":"The document type.","nullable":true},"number":{"type":"string","description":"The document number.","nullable":true},"serialNumber":{"type":"string","description":"The document serial number.","nullable":true},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true},"issuedBy":{"type":"string","description":"The issuing authority.","nullable":true},"issuedOn":{"type":"string","description":"When the document was issued.","format":"date-time","nullable":true},"expiresAt":{"type":"string","description":"When the document expires.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Identity document for disposable certificate during update."}},"components/schemas/UpdateDisposableCertificateIdentification":{"id":"components/schemas/UpdateDisposableCertificateIdentification","kind":"json-schema","title":"UpdateDisposableCertificateIdentification","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DisposableCertificateIdentificationType"},"issuingCountry":{"type":"string","description":"The issuing country.","nullable":true}},"additionalProperties":false,"description":"Identification method for disposable certificate during update."}},"components/schemas/UpdateDocumentClassRequest":{"id":"components/schemas/UpdateDocumentClassRequest","kind":"json-schema","title":"UpdateDocumentClassRequest","data":{"required":["description","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The document class name.","example":"Contract"},"description":{"type":"string","description":"A description of the document class.","example":"Documents related to contracts"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/DocumentClassMetadataReferenceRequest"},"description":"The metadata field references for this document class."}},"additionalProperties":false,"description":"Request body for updating a document class."}},"components/schemas/UpdateDocumentMetadataRequest":{"id":"components/schemas/UpdateDocumentMetadataRequest","kind":"json-schema","title":"UpdateDocumentMetadataRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}},"components/schemas/UpdateEnvelopeAutomaticRecipientRequest":{"id":"components/schemas/UpdateEnvelopeAutomaticRecipientRequest","kind":"json-schema","title":"UpdateEnvelopeAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateEnvelopeRecipientRequest"},{"required":["signatureProfile"],"type":"object","properties":{"signatureProfile":{"type":"string","description":"Signature profile name for the automatic recipient.","nullable":true,"example":"default-eseal-profile"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request to update an automatic recipient in an envelope stage.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/UpdateEnvelopeFileDetailRequest":{"id":"components/schemas/UpdateEnvelopeFileDetailRequest","kind":"json-schema","title":"UpdateEnvelopeFileDetailRequest","data":{"required":["documentClass"],"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/UpdateEnvelopeFileDocumentClassRequest"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file. Null means no change.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the details of an envelope file."}},"components/schemas/UpdateEnvelopeFileDocumentClassRequest":{"id":"components/schemas/UpdateEnvelopeFileDocumentClassRequest","kind":"json-schema","title":"UpdateEnvelopeFileDocumentClassRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The document class identifier.","format":"uuid"},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringMetadataValueRequest"},{"$ref":"#/components/schemas/NumberMetadataValueRequest"},{"$ref":"#/components/schemas/DateMetadataValueRequest"},{"$ref":"#/components/schemas/ListOptionMetadataValueRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata values to assign.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the document class of an envelope file."}},"components/schemas/UpdateEnvelopeFileTasksRequest":{"id":"components/schemas/UpdateEnvelopeFileTasksRequest","kind":"json-schema","title":"UpdateEnvelopeFileTasksRequest","data":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/FieldTaskRequest"},"description":"The complete list of tasks for the file."}},"additionalProperties":false,"description":"Request body for replacing file tasks."}},"components/schemas/UpdateEnvelopeRecipientRequest":{"id":"components/schemas/UpdateEnvelopeRecipientRequest","kind":"json-schema","title":"UpdateEnvelopeRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update envelope recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/UpdateEnvelopeReminderRequest":{"id":"components/schemas/UpdateEnvelopeReminderRequest","kind":"json-schema","title":"UpdateEnvelopeReminderRequest","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/UpdateEnvelopeRequest":{"id":"components/schemas/UpdateEnvelopeRequest","kind":"json-schema","title":"UpdateEnvelopeRequest","data":{"required":["expiration","name","reminder"],"type":"object","properties":{"name":{"type":"string","description":"The envelope name.","example":"Updated contract name"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteUpdateEnvelopeExpirationRequest"},{"$ref":"#/components/schemas/RelativeUpdateEnvelopeExpirationRequest"}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/UpdateEnvelopeReminderRequest"},"qualifiedTimeStamp":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether all signatures in the envelope must use a qualified timestamp server. Optional. When omitted, the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied at the downstream Nova boundary."},"children":[]}]}]}],"nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient. Null means no change.","nullable":true,"example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"https://example.com/envelope-sent"}},"additionalProperties":false,"description":"Request body for updating an envelope."}},"components/schemas/UpdateEnvelopeStageRequest":{"id":"components/schemas/UpdateEnvelopeStageRequest","kind":"json-schema","title":"UpdateEnvelopeStageRequest","data":{"required":["name","requiredRecipientCompletions","type"],"type":"object","properties":{"name":{"type":"string","description":"The stage name.","example":"Updated Stage Name"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"}},"additionalProperties":false,"description":"Request body for updating a stage."}},"components/schemas/UpdateEnvelopeStandardRecipientRequest":{"id":"components/schemas/UpdateEnvelopeStandardRecipientRequest","kind":"json-schema","title":"UpdateEnvelopeStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateEnvelopeRecipientRequest"},{"required":["email","givenName","notificationChannels","phoneNumber","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true,"example":"Mario"},"surname":{"type":"string","description":"The recipient's last name.","nullable":true,"example":"Rossi"},"email":{"type":"string","description":"The recipient's email address.","nullable":true,"example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true,"example":"+39123456789"},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/UpdateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/UpdateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true,"example":"Please review and sign the attached contract."},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for updating a Standard recipient."}},"components/schemas/UpdateEnvelopeWebhookRequest":{"id":"components/schemas/UpdateEnvelopeWebhookRequest","kind":"json-schema","title":"UpdateEnvelopeWebhookRequest","data":{"required":["event","url"],"type":"object","properties":{"url":{"type":"string","description":"The URL receiving the webhook calls (max 2048 characters).","example":"https://example.com/hooks/envelope-new"},"event":{"$ref":"#/components/schemas/WebhookEventType"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationRequest"}},"additionalProperties":false,"description":"Request body for updating an envelope webhook."}},"components/schemas/UpdateGeneralSettingsRequest":{"id":"components/schemas/UpdateGeneralSettingsRequest","kind":"json-schema","title":"UpdateGeneralSettingsRequest","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Request to update the general settings of an organization."}},"components/schemas/UpdateLanguageSettingsRequest":{"id":"components/schemas/UpdateLanguageSettingsRequest","kind":"json-schema","title":"UpdateLanguageSettingsRequest","data":{"required":["languages"],"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"},"description":"The language codes to enable for the organization. Replaces the entire list."}},"additionalProperties":false,"description":"Request to replace the enabled languages of an organization."}},"components/schemas/UpdateListOptionDocumentMetadataRequest":{"id":"components/schemas/UpdateListOptionDocumentMetadataRequest","kind":"json-schema","title":"UpdateListOptionDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateDocumentMetadataRequest"},{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadataOptionRequest"},"description":"The predefined selectable options. Must be non-empty. Fully replaces the existing set.","nullable":true},"parentId":{"type":"string","description":"The ID of an existing metadata field of type ListOptionType to set as this field's parent, or omit for no parent. Must not be this field itself or one of its children.","format":"uuid","nullable":true}},"additionalProperties":false}],"properties":{"type":{"enum":["ListOptionType"],"type":"string","default":"ListOptionType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.ListOptionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"options":[{"value":"Invoice","parentId":"8d2b352e-e36a-45c1-904c-61c599d9bf6e"},{"value":"NDA"}],"parentId":"bb1fb957-ed45-4ba6-b10f-31594e765cb5","type":"ListOptionType","name":"ContractType"}}},"components/schemas/UpdateNumberDocumentMetadataRequest":{"id":"components/schemas/UpdateNumberDocumentMetadataRequest","kind":"json-schema","title":"UpdateNumberDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["NumberType"],"type":"string","default":"NumberType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.NumberType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"NumberType","name":"TotalAmount"}}},"components/schemas/UpdateOAuthAuthentication":{"id":"components/schemas/UpdateOAuthAuthentication","kind":"json-schema","title":"UpdateOAuthAuthentication","data":{"required":["id"],"type":"object","properties":{"providerName":{"type":"string","description":"The OAuth provider name.","nullable":true},"id":{"type":"string","description":"The identifier of the OAuth provider.","format":"uuid"}},"additionalProperties":false,"description":"OAuth authentication configuration for update."}},"components/schemas/UpdateOneTimePasswordRequest":{"id":"components/schemas/UpdateOneTimePasswordRequest","kind":"json-schema","title":"UpdateOneTimePasswordRequest","data":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether one time password authentication is enabled."}},"additionalProperties":false,"description":"One-time password authentication configuration to enable."}},"components/schemas/UpdateOneTimePasswordRequestOptionalNullable":{"id":"components/schemas/UpdateOneTimePasswordRequestOptionalNullable","kind":"json-schema","title":"UpdateOneTimePasswordRequestOptionalNullable","data":{"required":["isSet"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateOneTimePasswordRequest"}},"additionalProperties":false}},"components/schemas/UpdateOrganizationWebhookRequest":{"id":"components/schemas/UpdateOrganizationWebhookRequest","kind":"json-schema","title":"UpdateOrganizationWebhookRequest","data":{"required":["event","url"],"type":"object","properties":{"url":{"type":"string","description":"The URL receiving the webhook calls (max 2048 characters).","example":"https://example.com/hooks/organization-new"},"event":{"$ref":"#/components/schemas/WebhookEventType"},"authentication":{"$ref":"#/components/schemas/WebhookAuthenticationRequest"}},"additionalProperties":false,"description":"Request body for updating an organization webhook."}},"components/schemas/UpdateOtpSignature":{"id":"components/schemas/UpdateOtpSignature","kind":"json-schema","title":"UpdateOtpSignature","data":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/OtpDeliveryChannel"}},"additionalProperties":false,"description":"OTP signature configuration for update."}},"components/schemas/UpdatePolicyRequest":{"id":"components/schemas/UpdatePolicyRequest","kind":"json-schema","title":"UpdatePolicyRequest","data":{"required":["actions","conditions","isActive","name"],"type":"object","properties":{"name":{"type":"string","description":"The policy name.","example":"Standard signing policy"},"isActive":{"type":"boolean","description":"Whether the policy is active.","example":true},"description":{"type":"string","description":"The policy description.","nullable":true,"example":"Policy applied to all standard signing envelopes"},"documentClassId":{"type":"string","description":"The document class this policy applies to, when set.","format":"uuid","nullable":true},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/PolicyConditionRequest"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The policy's conditions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must start at 1, be unique, and contiguous within the list."},"children":[]}]}]}]},"actions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AddEnvelopeStageConfigurationActionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single action within a policy request. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The policy's actions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must start at 1, be unique, and contiguous within the list."},"children":[]}]}]}]}},"additionalProperties":false,"description":"Request body for updating a policy."}},"components/schemas/UpdateRecipientAuthentication":{"id":"components/schemas/UpdateRecipientAuthentication","kind":"json-schema","title":"UpdateRecipientAuthentication","data":{"type":"object","properties":{"accessCode":{"$ref":"#/components/schemas/UpdateAccessCode"},"oneTimePassword":{"$ref":"#/components/schemas/UpdateAuthenticationOneTimePassword"},"oAuthAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/UpdateOAuthAuthentication"},"description":"OAuth authentications.","nullable":true}},"additionalProperties":false,"description":"Recipient authentication configuration for update."}},"components/schemas/UpdateRecipientAuthenticationsRequest":{"id":"components/schemas/UpdateRecipientAuthenticationsRequest","kind":"json-schema","title":"UpdateRecipientAuthenticationsRequest","data":{"type":"object","properties":{"accessCode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether access code authentication is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"oneTimePassword":{"oneOf":[{"$ref":"#/components/schemas/UpdateOneTimePasswordRequest"},{"enum":[null],"nullable":true}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The one-time password authentication configuration. May be omitted, set to null to disable, or set to a value to enable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Recipient authentication settings values to persist. Unset fields retain their current value."}},"components/schemas/UpdateRecipientAuthenticationsRequestOptional":{"id":"components/schemas/UpdateRecipientAuthenticationsRequestOptional","kind":"json-schema","title":"UpdateRecipientAuthenticationsRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateRecipientAuthenticationsRequest"}},"additionalProperties":false}},"components/schemas/UpdateRecipientSettingsRequest":{"id":"components/schemas/UpdateRecipientSettingsRequest","kind":"json-schema","title":"UpdateRecipientSettingsRequest","data":{"type":"object","properties":{"sendCompletedFileToAllRecipients":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the completed file is sent to all recipients."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"warnIfRecipientsHaveNoFields":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a warning is shown when some recipients have no fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"authentications":{"oneOf":[{"$ref":"#/components/schemas/UpdateRecipientAuthenticationsRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's recipient authentication settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"recipientDelegation":{"oneOf":[{"$ref":"#/components/schemas/RecipientDelegation"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's recipient delegation policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"mandatoryAuthentication":{"oneOf":[{"$ref":"#/components/schemas/MandatoryAuthenticationNone"},{"$ref":"#/components/schemas/MandatoryAuthenticationAny"},{"$ref":"#/components/schemas/MandatoryAuthenticationAccessCode"},{"$ref":"#/components/schemas/MandatoryAuthenticationOneTimePassword"},{"$ref":"#/components/schemas/MandatoryAuthenticationOAuth"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's mandatory (forced) recipient authentication method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Request to update the recipient settings of an organization."}},"components/schemas/UpdateRecipientSignatureData":{"id":"components/schemas/UpdateRecipientSignatureData","kind":"json-schema","title":"UpdateRecipientSignatureData","data":{"type":"object","properties":{"disposableCertificate":{"$ref":"#/components/schemas/UpdateDisposableCertificate"},"remoteCertificate":{"$ref":"#/components/schemas/UpdateRemoteCertificateDto"},"otpSignature":{"$ref":"#/components/schemas/UpdateOtpSignature"},"signingPlugins":{"$ref":"#/components/schemas/UpdateSigningPlugins"}},"additionalProperties":false,"description":"Signature configuration for a recipient during update."}},"components/schemas/UpdateRegionalDefaultsSettingsRequest":{"id":"components/schemas/UpdateRegionalDefaultsSettingsRequest","kind":"json-schema","title":"UpdateRegionalDefaultsSettingsRequest","data":{"required":["dateTimeFormat","language","timeZone"],"type":"object","properties":{"timeZone":{"type":"string","description":"The default IANA time zone identifier.","example":"Europe/Berlin"},"dateTimeFormat":{"$ref":"#/components/schemas/DateTimeFormat"},"language":{"type":"string","description":"The default language code. Must be one of the organization's enabled languages.","example":"en"}},"additionalProperties":false,"description":"Request to replace the regional defaults of an organization."}},"components/schemas/UpdateRemoteCertificateDto":{"id":"components/schemas/UpdateRemoteCertificateDto","kind":"json-schema","title":"UpdateRemoteCertificateDto","data":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID.","nullable":true},"deviceId":{"type":"string","description":"The device ID.","nullable":true}},"additionalProperties":false,"description":"Remote certificate configuration for update."}},"components/schemas/UpdateSignatureSettingsDisposableCertificate":{"id":"components/schemas/UpdateSignatureSettingsDisposableCertificate","kind":"json-schema","title":"UpdateSignatureSettingsDisposableCertificate","data":{"type":"object","properties":{"lraId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The LRA identifier. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"user":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user identifier. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"password":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The disposable certificate password. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"disposableType":{"oneOf":[{"$ref":"#/components/schemas/DisposableCertificateType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The disposable certificate type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"showDisclaimerBeforeCertificateRequest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the disclaimer is shown before requesting the certificate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"sendDisposableDisclaimerDocumentNotifications":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether disclaimer document notifications are sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Disposable certificate configuration values to persist, including the optional password. Unset fields retain their current value."}},"components/schemas/UpdateSignatureSettingsDisposableCertificateOptional":{"id":"components/schemas/UpdateSignatureSettingsDisposableCertificateOptional","kind":"json-schema","title":"UpdateSignatureSettingsDisposableCertificateOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateSignatureSettingsDisposableCertificate"}},"additionalProperties":false}},"components/schemas/UpdateSignatureSettingsRequest":{"id":"components/schemas/UpdateSignatureSettingsRequest","kind":"json-schema","title":"UpdateSignatureSettingsRequest","data":{"type":"object","properties":{"defaultSignatureType":{"oneOf":[{"$ref":"#/components/schemas/DefaultSignatureType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's default signature type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"auditTrailMode":{"oneOf":[{"$ref":"#/components/schemas/AuditTrailMode"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's audit trail generation mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"timestamp":{"oneOf":[{"$ref":"#/components/schemas/UpdateSignatureSettingsTimestamp"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's timestamp server configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"disposableCertificate":{"oneOf":[{"$ref":"#/components/schemas/UpdateSignatureSettingsDisposableCertificate"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization's disposable certificate configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Request to update the signature settings of an organization."}},"components/schemas/UpdateSignatureSettingsTimestamp":{"id":"components/schemas/UpdateSignatureSettingsTimestamp","kind":"json-schema","title":"UpdateSignatureSettingsTimestamp","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp server URL. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp server username. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"password":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp server password. May be omitted, set to null/empty to clear, or set to a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"nullable":true},"hashAlgorithm":{"oneOf":[{"$ref":"#/components/schemas/TimestampHashAlgorithm"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hash algorithm used by the timestamp server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Timestamp server configuration values to persist, including the password. Unset fields retain their current value."}},"components/schemas/UpdateSignatureSettingsTimestampOptional":{"id":"components/schemas/UpdateSignatureSettingsTimestampOptional","kind":"json-schema","title":"UpdateSignatureSettingsTimestampOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateSignatureSettingsTimestamp"}},"additionalProperties":false}},"components/schemas/UpdateSigningPlugin":{"id":"components/schemas/UpdateSigningPlugin","kind":"json-schema","title":"UpdateSigningPlugin","data":{"type":"object","properties":{"pluginId":{"type":"string","description":"The plugin ID.","nullable":true},"settings":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSigningPluginSetting"},"description":"The plugin settings.","nullable":true}},"additionalProperties":false,"description":"A signing plugin for update."}},"components/schemas/UpdateSigningPluginSetting":{"id":"components/schemas/UpdateSigningPluginSetting","kind":"json-schema","title":"UpdateSigningPluginSetting","data":{"type":"object","properties":{"key":{"type":"string","description":"The setting key.","nullable":true},"value":{"type":"string","description":"The setting value.","nullable":true}},"additionalProperties":false,"description":"A signing plugin setting for update."}},"components/schemas/UpdateSigningPlugins":{"id":"components/schemas/UpdateSigningPlugins","kind":"json-schema","title":"UpdateSigningPlugins","data":{"type":"object","properties":{"plugins":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSigningPlugin"},"description":"The list of signing plugins.","nullable":true}},"additionalProperties":false,"description":"Signing plugins configuration for update."}},"components/schemas/UpdateStringDocumentMetadataRequest":{"id":"components/schemas/UpdateStringDocumentMetadataRequest","kind":"json-schema","title":"UpdateStringDocumentMetadataRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateDocumentMetadataRequest"},{"type":"object","additionalProperties":false}],"properties":{"type":{"enum":["StringType"],"type":"string","default":"StringType"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataValueType.StringType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"type":"StringType","name":"ContractNumber"}}},"components/schemas/UpdateTemplateAutomaticRecipientRequest":{"id":"components/schemas/UpdateTemplateAutomaticRecipientRequest","kind":"json-schema","title":"UpdateTemplateAutomaticRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateTemplateRecipientRequest"},{"required":["signatureProfile"],"type":"object","properties":{"signatureProfile":{"type":"string","description":"The friendly name of the eSealing signature profile.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."}},"additionalProperties":false}],"properties":{"type":{"enum":["Automatic"],"type":"string","default":"Automatic"}},"description":"Request body for updating an Automatic recipient.","example":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"}}},"components/schemas/UpdateTemplateFileDetailRequest":{"id":"components/schemas/UpdateTemplateFileDetailRequest","kind":"json-schema","title":"UpdateTemplateFileDetailRequest","data":{"required":["documentClass"],"type":"object","properties":{"documentClass":{"$ref":"#/components/schemas/UpdateTemplateFileDocumentClassRequest"},"restrictedVisibilityRecipientIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of recipients with restricted visibility to this file. Null means no change.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the details of a template file."}},"components/schemas/UpdateTemplateFileDocumentClassRequest":{"id":"components/schemas/UpdateTemplateFileDocumentClassRequest","kind":"json-schema","title":"UpdateTemplateFileDocumentClassRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The document class identifier.","format":"uuid"},"metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StringMetadataValueRequest"},{"$ref":"#/components/schemas/NumberMetadataValueRequest"},{"$ref":"#/components/schemas/DateMetadataValueRequest"},{"$ref":"#/components/schemas/ListOptionMetadataValueRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata field value. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"StringType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NumberType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DateType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ListOptionType\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"The metadata values to assign.","nullable":true}},"additionalProperties":false,"description":"Request body for updating the document class of a template file."}},"components/schemas/UpdateTemplateFileTasksRequest":{"id":"components/schemas/UpdateTemplateFileTasksRequest","kind":"json-schema","title":"UpdateTemplateFileTasksRequest","data":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/FieldTaskRequest"},"description":"The complete list of tasks for the file."}},"additionalProperties":false,"description":"Request body for replacing file tasks."}},"components/schemas/UpdateTemplateRecipientRequest":{"id":"components/schemas/UpdateTemplateRecipientRequest","kind":"json-schema","title":"UpdateTemplateRecipientRequest","data":{"type":"object","properties":{"languageCode":{"type":"string","description":"BCP 47 language code for recipient notifications.","nullable":true,"example":"en"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update template recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/UpdateTemplateReminderRequest":{"id":"components/schemas/UpdateTemplateReminderRequest","kind":"json-schema","title":"UpdateTemplateReminderRequest","data":{"required":["beforeExpirationInDays","enabled","firstReminderInDays","resendIntervalInDays"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether reminders are enabled.","example":true},"firstReminderInDays":{"type":"integer","description":"Days after sending before the first reminder.","format":"int32","example":5},"resendIntervalInDays":{"type":"integer","description":"Days between subsequent reminders.","format":"int32","example":3},"beforeExpirationInDays":{"type":"integer","description":"Days before expiration to send the last reminder.","format":"int32","example":2}},"additionalProperties":false,"description":"Reminder configuration."}},"components/schemas/UpdateTemplateRequest":{"id":"components/schemas/UpdateTemplateRequest","kind":"json-schema","title":"UpdateTemplateRequest","data":{"required":["expiration","name","reminder"],"type":"object","properties":{"name":{"type":"string","description":"The template name.","example":"Updated NDA template"},"expiration":{"oneOf":[{"$ref":"#/components/schemas/AbsoluteUpdateTemplateExpirationRequest"},{"$ref":"#/components/schemas/RelativeUpdateTemplateExpirationRequest"}],"description":"The expiration settings."},"reminder":{"$ref":"#/components/schemas/UpdateTemplateReminderRequest"},"qualifiedTimeStamp":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether all signatures in the template must use a qualified timestamp server. Optional. When omitted, the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied at the downstream Nova boundary."},"children":[]}]}]}],"nullable":true,"example":true},"signatureReason":{"type":"string","description":"The signature reason persisted on the template. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"Approved by Mario Rossi"},"signatureFormat":{"$ref":"#/components/schemas/SignatureFormat"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/Agreement"},"description":"The agreements per language. Null means no change (keep existing); empty list clears all agreements.","nullable":true},"fileRestrictedVisibility":{"type":"boolean","description":"Whether file visibility is restricted per recipient. Null means no change.","nullable":true,"example":false},"afterSendRedirectUrl":{"type":"string","description":"The URL to redirect to after sending the envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).","nullable":true,"example":"https://example.com/envelope-sent"}},"additionalProperties":false,"description":"Request body for updating a template."}},"components/schemas/UpdateTemplateStageRequest":{"id":"components/schemas/UpdateTemplateStageRequest","kind":"json-schema","title":"UpdateTemplateStageRequest","data":{"required":["name","requiredRecipientCompletions","type"],"type":"object","properties":{"name":{"type":"string","description":"The stage name.","example":"Updated Stage Name"},"requiredRecipientCompletions":{"type":"integer","description":"Number of recipients required to complete the stage.","format":"int32","example":1},"type":{"$ref":"#/components/schemas/StageType"}},"additionalProperties":false,"description":"Request body for updating a stage."}},"components/schemas/UpdateTemplateStandardRecipientRequest":{"id":"components/schemas/UpdateTemplateStandardRecipientRequest","kind":"json-schema","title":"UpdateTemplateStandardRecipientRequest","data":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/UpdateTemplateRecipientRequest"},{"required":["email","givenName","notificationChannels","phoneNumber","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The recipient's first name.","nullable":true},"surname":{"type":"string","description":"The recipient's last name.","nullable":true},"email":{"type":"string","description":"The recipient's email address.","nullable":true},"phoneNumber":{"type":"string","description":"The recipient's phone number.","nullable":true},"notificationChannels":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"},"description":"Channels used to notify the recipient.","nullable":true},"authentication":{"$ref":"#/components/schemas/UpdateRecipientAuthentication"},"signatureConfiguration":{"$ref":"#/components/schemas/UpdateRecipientSignatureData"},"personalMessage":{"type":"string","description":"A personal message included in the notification.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/RecipientMetadataEntry"},"description":"Recipient-level metadata injected into the workstep XML as additional client workstep information.","nullable":true},"signatureReason":{"type":"string","description":"Reason displayed at the recipient signing step.","nullable":true,"example":"I agree to the terms."},"isSignatureReasonEditable":{"type":"boolean","description":"Whether the recipient is allowed to edit the signature reason at signing time.","nullable":true,"example":false}},"additionalProperties":false}],"properties":{"type":{"enum":["Standard"],"type":"string","default":"Standard"}},"description":"Request body for updating a Standard recipient."}},"components/schemas/UpdateUserApplicationRolesRequest":{"id":"components/schemas/UpdateUserApplicationRolesRequest","kind":"json-schema","title":"UpdateUserApplicationRolesRequest","data":{"required":["applicationRoles"],"type":"object","properties":{"applicationRoles":{"type":"array","items":{"$ref":"#/components/schemas/UserApplicationRoleRequest"},"description":"The full set of application roles to assign to the user. Replaces any existing assignment."}},"additionalProperties":false,"description":"Request body for updating the application roles assigned to a user within an organization."}},"components/schemas/UpdateUserGroupContactCustomFieldRequest":{"id":"components/schemas/UpdateUserGroupContactCustomFieldRequest","kind":"json-schema","title":"UpdateUserGroupContactCustomFieldRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The contact custom field name.","example":"Tax code"}},"additionalProperties":false,"description":"Request body for updating a contact custom field."}},"components/schemas/UpdateUserGroupContactRequest":{"id":"components/schemas/UpdateUserGroupContactRequest","kind":"json-schema","title":"UpdateUserGroupContactRequest","data":{"type":"object","properties":{"givenName":{"type":"string","description":"The contact's first name.","nullable":true,"example":"John"},"surname":{"type":"string","description":"The contact's last name.","nullable":true,"example":"Smith"},"email":{"type":"string","description":"The contact's email address.","nullable":true,"example":"john.smith@example.com"},"phoneNumber":{"type":"string","description":"The contact's phone number.","nullable":true,"example":"+44 20 7946 0958"},"language":{"type":"string","description":"The contact's culture ISO code.","nullable":true,"example":"en"}},"additionalProperties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body that replaces a contact of a user group. The contact is replaced as a whole: a standard field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is not sent is cleared, and so is a custom field. The values of the group's custom fields are sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional properties next to the standard fields, keyed by custom field name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Tax code\": \"AB123456C\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"components/schemas/UpdateUserGroupContactsPermissionRequest":{"id":"components/schemas/UpdateUserGroupContactsPermissionRequest","kind":"json-schema","title":"UpdateUserGroupContactsPermissionRequest","data":{"type":"object","properties":{"read":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to read contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"createUpdateDelete":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to create, update, and delete contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"customize":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to customize contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Contacts management permissions."}},"components/schemas/UpdateUserGroupContactsPermissionRequestOptional":{"id":"components/schemas/UpdateUserGroupContactsPermissionRequestOptional","kind":"json-schema","title":"UpdateUserGroupContactsPermissionRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateUserGroupContactsPermissionRequest"}},"additionalProperties":false}},"components/schemas/UpdateUserGroupEnvelopesPermissionRequest":{"id":"components/schemas/UpdateUserGroupEnvelopesPermissionRequest","kind":"json-schema","title":"UpdateUserGroupEnvelopesPermissionRequest","data":{"type":"object","properties":{"share":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to share envelopes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"manage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to manage envelopes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Envelopes management permissions."}},"components/schemas/UpdateUserGroupEnvelopesPermissionRequestOptional":{"id":"components/schemas/UpdateUserGroupEnvelopesPermissionRequestOptional","kind":"json-schema","title":"UpdateUserGroupEnvelopesPermissionRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateUserGroupEnvelopesPermissionRequest"}},"additionalProperties":false}},"components/schemas/UpdateUserGroupPermissionRequest":{"id":"components/schemas/UpdateUserGroupPermissionRequest","kind":"json-schema","title":"UpdateUserGroupPermissionRequest","data":{"type":"object","properties":{"users":{"oneOf":[{"$ref":"#/components/schemas/UpdateUserGroupUsersPermissionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users management permissions to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"envelopes":{"oneOf":[{"$ref":"#/components/schemas/UpdateUserGroupEnvelopesPermissionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Envelopes management permissions to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"templates":{"oneOf":[{"$ref":"#/components/schemas/UpdateUserGroupTemplatesPermissionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates management permissions to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"contacts":{"oneOf":[{"$ref":"#/components/schemas/UpdateUserGroupContactsPermissionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts management permissions to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Permissions for a user in a group."}},"components/schemas/UpdateUserGroupPermissionRequestOptional":{"id":"components/schemas/UpdateUserGroupPermissionRequestOptional","kind":"json-schema","title":"UpdateUserGroupPermissionRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateUserGroupPermissionRequest"}},"additionalProperties":false}},"components/schemas/UpdateUserGroupRequest":{"id":"components/schemas/UpdateUserGroupRequest","kind":"json-schema","title":"UpdateUserGroupRequest","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The user group name.","example":"Sales Team"}},"additionalProperties":false,"description":"Request body for updating a user group."}},"components/schemas/UpdateUserGroupTemplatesPermissionRequest":{"id":"components/schemas/UpdateUserGroupTemplatesPermissionRequest","kind":"json-schema","title":"UpdateUserGroupTemplatesPermissionRequest","data":{"type":"object","properties":{"share":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to share templates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"manage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to manage templates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Templates management permissions."}},"components/schemas/UpdateUserGroupTemplatesPermissionRequestOptional":{"id":"components/schemas/UpdateUserGroupTemplatesPermissionRequestOptional","kind":"json-schema","title":"UpdateUserGroupTemplatesPermissionRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateUserGroupTemplatesPermissionRequest"}},"additionalProperties":false}},"components/schemas/UpdateUserGroupUserRequest":{"id":"components/schemas/UpdateUserGroupUserRequest","kind":"json-schema","title":"UpdateUserGroupUserRequest","data":{"type":"object","properties":{"permissions":{"oneOf":[{"$ref":"#/components/schemas/UpdateUserGroupPermissionRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional permissions to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"businessRoleId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional business role ID to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets to null, omission ignores property"},"children":[]}]}]}]}],"format":"uuid","nullable":true}},"additionalProperties":false,"description":"Request to update a user in a group (permissions and/or role)."}},"components/schemas/UpdateUserGroupUsersPermissionRequest":{"id":"components/schemas/UpdateUserGroupUsersPermissionRequest","kind":"json-schema","title":"UpdateUserGroupUsersPermissionRequest","data":{"type":"object","properties":{"read":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to read users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]},"createUpdateDelete":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to create, update, and delete users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional: omission ignores property"},"children":[]}]}]}]}]}},"additionalProperties":false,"description":"Users management permissions."}},"components/schemas/UpdateUserGroupUsersPermissionRequestOptional":{"id":"components/schemas/UpdateUserGroupUsersPermissionRequestOptional","kind":"json-schema","title":"UpdateUserGroupUsersPermissionRequestOptional","data":{"required":["isSet","value"],"type":"object","properties":{"isSet":{"type":"boolean","readOnly":true},"value":{"$ref":"#/components/schemas/UpdateUserGroupUsersPermissionRequest"}},"additionalProperties":false}},"components/schemas/UpdateUserRequest":{"id":"components/schemas/UpdateUserRequest","kind":"json-schema","title":"UpdateUserRequest","data":{"required":["givenName","regionalSettings","surname"],"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Mario"},"surname":{"type":"string","description":"The user's last name.","example":"Rossi"},"regionalSettings":{"$ref":"#/components/schemas/UserRegionalSettingsRequest"},"phoneNumber":{"type":"string","description":"The user's optional phone number. Pass null to remove the phone number.","nullable":true,"example":"+39021234567"}},"additionalProperties":false,"description":"Request body for updating a user within an organization."}},"components/schemas/UploadBulkEnvelopeFileResponse":{"id":"components/schemas/UploadBulkEnvelopeFileResponse","kind":"json-schema","title":"UploadBulkEnvelopeFileResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the uploaded file.","format":"uuid","example":"00000000-0000-0000-0000-000000000020"}},"additionalProperties":false,"description":"Response after uploading a bulk envelope file."}},"components/schemas/UploadEnvelopeFileResponse":{"id":"components/schemas/UploadEnvelopeFileResponse","kind":"json-schema","title":"UploadEnvelopeFileResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the uploaded file.","format":"uuid","example":"00000000-0000-0000-0000-000000000020"}},"additionalProperties":false,"description":"Response after uploading a file."}},"components/schemas/UploadTemplateFileResponse":{"id":"components/schemas/UploadTemplateFileResponse","kind":"json-schema","title":"UploadTemplateFileResponse","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the uploaded file.","format":"uuid"}},"additionalProperties":false,"description":"Response after uploading a file."}},"components/schemas/UserApplicationRoleRequest":{"id":"components/schemas/UserApplicationRoleRequest","kind":"json-schema","title":"UserApplicationRoleRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The application role ID.","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},"additionalProperties":false,"description":"Reference to an application role to assign to a user."}},"components/schemas/UserGroupContactCustomFieldListResponse":{"id":"components/schemas/UserGroupContactCustomFieldListResponse","kind":"json-schema","title":"UserGroupContactCustomFieldListResponse","data":{"required":["customFields"],"type":"object","properties":{"customFields":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupContactCustomFieldSummary"},"description":"The custom fields of the group."}},"additionalProperties":false,"description":"List of the custom fields defined for the contacts of a user group."}},"components/schemas/UserGroupContactCustomFieldSummary":{"id":"components/schemas/UserGroupContactCustomFieldSummary","kind":"json-schema","title":"UserGroupContactCustomFieldSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contact custom field. Use this ID to retrieve, update, or delete the field.","format":"uuid","example":"400658ab-5f75-43c3-aff1-1ca6a046d9fa"},"name":{"type":"string","description":"The custom field name.","example":"Tax code"}},"additionalProperties":false,"description":"Custom field defined for the contacts of a user group."}},"components/schemas/UserGroupContactListResponse":{"id":"components/schemas/UserGroupContactListResponse","kind":"json-schema","title":"UserGroupContactListResponse","data":{"required":["contacts","pagination"],"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupContactSummary"},"description":"The contacts of the group."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of the contacts shared in a user group."}},"components/schemas/UserGroupContactSummary":{"id":"components/schemas/UserGroupContactSummary","kind":"json-schema","title":"UserGroupContactSummary","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The contact ID.","format":"uuid","example":"e201ace1-7752-4a33-a9b3-2a46902e8de3"},"email":{"type":"string","description":"The contact's email address.","nullable":true,"example":"john.smith@example.com"},"givenName":{"type":"string","description":"The contact's first name.","nullable":true,"example":"John"},"surname":{"type":"string","description":"The contact's last name.","nullable":true,"example":"Smith"},"phoneNumber":{"type":"string","description":"The contact's phone number.","nullable":true,"example":"+44 20 7946 0958"},"language":{"type":"string","description":"The contact's culture ISO code.","nullable":true,"example":"en"}},"additionalProperties":{},"description":"Summary representation of a contact shared in a user group."}},"components/schemas/UserGroupContactsPermission":{"id":"components/schemas/UserGroupContactsPermission","kind":"json-schema","title":"UserGroupContactsPermission","data":{"required":["createUpdateDelete","customize","read"],"type":"object","properties":{"read":{"type":"boolean","description":"Whether the user has permission to read contacts."},"createUpdateDelete":{"type":"boolean","description":"Whether the user has permission to create, update, and delete contacts."},"customize":{"type":"boolean","description":"Whether the user has permission to customize contacts."}},"additionalProperties":false,"description":"Contacts management permissions."}},"components/schemas/UserGroupEnvelopesPermission":{"id":"components/schemas/UserGroupEnvelopesPermission","kind":"json-schema","title":"UserGroupEnvelopesPermission","data":{"required":["manage","share"],"type":"object","properties":{"share":{"type":"boolean","description":"Whether the user has permission to share envelopes."},"manage":{"type":"boolean","description":"Whether the user has permission to manage envelopes."}},"additionalProperties":false,"description":"Envelopes management permissions."}},"components/schemas/UserGroupListResponse":{"id":"components/schemas/UserGroupListResponse","kind":"json-schema","title":"UserGroupListResponse","data":{"required":["pagination","userGroups"],"type":"object","properties":{"userGroups":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupSummary"},"description":"The list of user groups."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of user groups."}},"components/schemas/UserGroupPermission":{"id":"components/schemas/UserGroupPermission","kind":"json-schema","title":"UserGroupPermission","data":{"required":["contacts","envelopes","templates","users"],"type":"object","properties":{"users":{"$ref":"#/components/schemas/UserGroupUsersPermission"},"envelopes":{"$ref":"#/components/schemas/UserGroupEnvelopesPermission"},"templates":{"$ref":"#/components/schemas/UserGroupTemplatesPermission"},"contacts":{"$ref":"#/components/schemas/UserGroupContactsPermission"}},"additionalProperties":false,"description":"Permissions for a user in a group."}},"components/schemas/UserGroupSummary":{"id":"components/schemas/UserGroupSummary","kind":"json-schema","title":"UserGroupSummary","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The user group ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The user group name.","example":"Sales Team"}},"additionalProperties":false,"description":"Summary representation of a user group."}},"components/schemas/UserGroupTemplatesPermission":{"id":"components/schemas/UserGroupTemplatesPermission","kind":"json-schema","title":"UserGroupTemplatesPermission","data":{"required":["manage","share"],"type":"object","properties":{"share":{"type":"boolean","description":"Whether the user has permission to share templates."},"manage":{"type":"boolean","description":"Whether the user has permission to manage templates."}},"additionalProperties":false,"description":"Templates management permissions."}},"components/schemas/UserGroupUserListResponse":{"id":"components/schemas/UserGroupUserListResponse","kind":"json-schema","title":"UserGroupUserListResponse","data":{"required":["pagination","users"],"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupUserSummary"},"description":"The list of users in the group."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of users in a user group."}},"components/schemas/UserGroupUserResponse":{"id":"components/schemas/UserGroupUserResponse","kind":"json-schema","title":"UserGroupUserResponse","data":{"required":["id","permissions"],"type":"object","properties":{"id":{"type":"string","description":"The user ID.","format":"uuid"},"permissions":{"$ref":"#/components/schemas/UserGroupPermission"},"businessRoleId":{"type":"string","description":"The assigned business role ID, if any.","format":"uuid","nullable":true}},"additionalProperties":false,"description":"Detailed representation of a user in a user group (excludes businessRole)."}},"components/schemas/UserGroupUserSummary":{"id":"components/schemas/UserGroupUserSummary","kind":"json-schema","title":"UserGroupUserSummary","data":{"required":["email","givenName","id","surname"],"type":"object","properties":{"id":{"type":"string","description":"The user ID.","format":"uuid"},"email":{"type":"string","description":"The user's email address."},"givenName":{"type":"string","description":"The user's first name."},"surname":{"type":"string","description":"The user's last name."}},"additionalProperties":false,"description":"Summary representation of a user in a user group (excludes identity fields)."}},"components/schemas/UserGroupUsersPermission":{"id":"components/schemas/UserGroupUsersPermission","kind":"json-schema","title":"UserGroupUsersPermission","data":{"required":["createUpdateDelete","read"],"type":"object","properties":{"read":{"type":"boolean","description":"Whether the user has permission to read users."},"createUpdateDelete":{"type":"boolean","description":"Whether the user has permission to create, update, and delete users."}},"additionalProperties":false,"description":"Users management permissions."}},"components/schemas/UserGroupsSortingKey":{"id":"components/schemas/UserGroupsSortingKey","kind":"json-schema","title":"UserGroupsSortingKey","data":{"enum":["Name"],"type":"string","description":"The available sorting keys for listing user groups."}},"components/schemas/UserListResponse":{"id":"components/schemas/UserListResponse","kind":"json-schema","title":"UserListResponse","data":{"required":["pagination","users"],"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSummary"},"description":"The list of users."},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"additionalProperties":false,"description":"Paginated list of users."}},"components/schemas/UserRegionalSettingsRequest":{"id":"components/schemas/UserRegionalSettingsRequest","kind":"json-schema","title":"UserRegionalSettingsRequest","data":{"required":["country","dateTimeFormat","language","timeZone"],"type":"object","properties":{"timeZone":{"type":"string","description":"The IANA time zone identifier.","example":"Europe/Berlin"},"dateTimeFormat":{"$ref":"#/components/schemas/DateTimeFormat"},"language":{"type":"string","description":"BCP 47 language code.","example":"en"},"country":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"IT"}},"additionalProperties":false,"description":"Regional settings for a new user."}},"components/schemas/UserRegionalSettingsResponse":{"id":"components/schemas/UserRegionalSettingsResponse","kind":"json-schema","title":"UserRegionalSettingsResponse","data":{"required":["country","dateTimeFormat","language","timeZone"],"type":"object","properties":{"timeZone":{"type":"string","description":"The IANA time zone identifier.","example":"Europe/Berlin"},"language":{"type":"string","description":"BCP 47 language code.","example":"it"},"country":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"IT"},"dateTimeFormat":{"type":"string","description":"The date and time display format string.","example":"dd/MM/yyyy | HH:mm"}},"additionalProperties":false,"description":"Regional settings returned for a user."}},"components/schemas/UserResponse":{"id":"components/schemas/UserResponse","kind":"json-schema","title":"UserResponse","data":{"required":["email","givenName","id","surname"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique identifier.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"givenName":{"type":"string","description":"The user's first name.","example":"Mario"},"surname":{"type":"string","description":"The user's last name.","example":"Rossi"},"email":{"type":"string","description":"The user's email address.","example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The user's optional phone number.","nullable":true,"example":"+39021234567"},"regionalSettings":{"$ref":"#/components/schemas/UserRegionalSettingsResponse"}},"additionalProperties":false,"description":"Detailed representation of a user."}},"components/schemas/UserSortingKey":{"id":"components/schemas/UserSortingKey","kind":"json-schema","title":"UserSortingKey","data":{"enum":["GivenName","Surname","Email"],"type":"string","description":"Sorting keys available when listing users in an organization."}},"components/schemas/UserSummary":{"id":"components/schemas/UserSummary","kind":"json-schema","title":"UserSummary","data":{"required":["email","givenName","id","surname"],"type":"object","properties":{"id":{"type":"string","description":"The user identifier.","format":"uuid","example":"00000000-0000-0000-0000-000000000001"},"givenName":{"type":"string","description":"The user's given name.","example":"Mario"},"surname":{"type":"string","description":"The user's surname.","example":"Rossi"},"email":{"type":"string","description":"The user's email address.","example":"mario.rossi@example.com"},"phoneNumber":{"type":"string","description":"The user's phone number, if set.","nullable":true,"example":"+39 02 1234567"}},"additionalProperties":false,"description":"Summary representation of a user."}},"components/schemas/VerifyEnvelopePoliciesResponse":{"id":"components/schemas/VerifyEnvelopePoliciesResponse","kind":"json-schema","title":"VerifyEnvelopePoliciesResponse","data":{"required":["compliant"],"type":"object","properties":{"compliant":{"type":"boolean","description":"Whether the envelope satisfies all applicable document class policies."}},"additionalProperties":false,"description":"Response from verifying envelope policies."}},"components/schemas/WebhookAuthenticationRequest":{"id":"components/schemas/WebhookAuthenticationRequest","kind":"json-schema","title":"WebhookAuthenticationRequest","data":{"type":"object","properties":{"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional HTTP headers to include in webhook calls.","nullable":true},"clientCertificate":{"type":"string","description":"Optional PEM-encoded client certificate for mTLS.","nullable":true},"clientKey":{"type":"string","description":"Optional PEM-encoded private key for mTLS.","nullable":true}},"additionalProperties":false,"description":"Authentication settings for the webhook endpoint."}},"components/schemas/WebhookAuthenticationResponse":{"id":"components/schemas/WebhookAuthenticationResponse","kind":"json-schema","title":"WebhookAuthenticationResponse","data":{"type":"object","properties":{"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"HTTP headers sent with the webhook calls; the values are obfuscated.","nullable":true},"clientCertificate":{"type":"string","description":"Obfuscated client certificate, when configured.","nullable":true},"clientKey":{"type":"string","description":"Obfuscated client key, when configured.","nullable":true}},"additionalProperties":false,"description":"Authentication settings of a webhook. Header names are returned as-is, every secret value is obfuscated with asterisks."}},"components/schemas/WebhookEventType":{"id":"components/schemas/WebhookEventType","kind":"json-schema","title":"WebhookEventType","data":{"enum":["EnvelopeSent","EnvelopeCompleted","EnvelopeCanceled","EnvelopeRestarted","EnvelopeDeleted","RecipientCompleted","RecipientRejected","RecipientDelegated"],"type":"string","description":"Events a webhook can be configured for. Envelope webhooks support every event, organization webhooks only EnvelopeCompleted."}},"components/schemas/WebhookSubscriptionResponse":{"id":"components/schemas/WebhookSubscriptionResponse","kind":"json-schema","title":"WebhookSubscriptionResponse","data":{"required":["createdAt","hasClientCertificate","hasHeaders","id","url"],"type":"object","properties":{"id":{"type":"string","description":"The subscription ID.","format":"uuid"},"url":{"type":"string","description":"The webhook delivery URL."},"hasHeaders":{"type":"boolean","description":"Whether custom headers are configured."},"hasClientCertificate":{"type":"boolean","description":"Whether mTLS is configured."},"createdAt":{"type":"string","description":"When the subscription was created.","format":"date-time"}},"additionalProperties":false,"description":"Response model for a webhook subscription."}},"schema_0":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BulkEnvelopeSortingKey"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"},"documentClassId":{"type":"string","format":"uuid","example":""}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateBulkEnvelopeStageAutomaticRecipientRequest"},{"$ref":"#/components/schemas/CreateBulkEnvelopeStageStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create bulk envelope stage recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/UpdateBulkEnvelopeStageAutomaticRecipientRequest"},{"$ref":"#/components/schemas/UpdateBulkEnvelopeStageStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update bulk envelope stage recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":1},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":20},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateStringDocumentMetadataRequest"},{"$ref":"#/components/schemas/CreateNumberDocumentMetadataRequest"},{"$ref":"#/components/schemas/CreateDateDocumentMetadataRequest"},{"$ref":"#/components/schemas/CreateListOptionDocumentMetadataRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateStringDocumentMetadataResponse"},{"$ref":"#/components/schemas/CreateNumberDocumentMetadataResponse"},{"$ref":"#/components/schemas/CreateDateDocumentMetadataResponse"},{"$ref":"#/components/schemas/CreateListOptionDocumentMetadataResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response after creating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/StringDocumentMetadataItem"},{"$ref":"#/components/schemas/NumberDocumentMetadataItem"},{"$ref":"#/components/schemas/DateDocumentMetadataItem"},{"$ref":"#/components/schemas/ListOptionDocumentMetadataItem"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a document metadata field at the organization level. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/UpdateStringDocumentMetadataRequest"},{"$ref":"#/components/schemas/UpdateNumberDocumentMetadataRequest"},{"$ref":"#/components/schemas/UpdateDateDocumentMetadataRequest"},{"$ref":"#/components/schemas/UpdateListOptionDocumentMetadataRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for updating a document metadata field. Discriminated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EnvelopeStatusFilter"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EnvelopeSortingKey"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","example":"attachment; filename=\"file\"","description":"Suggested filename for the downloaded file."}}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateEnvelopeAutomaticRecipientRequest"},{"$ref":"#/components/schemas/CreateEnvelopeStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create envelope recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/EnvelopeStandardRecipientResponse"},{"$ref":"#/components/schemas/EnvelopeAutomaticRecipientResponse"}],"description":"Detailed representation of a recipient. Base for polymorphic response."},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/UpdateEnvelopeAutomaticRecipientRequest"},{"$ref":"#/components/schemas/UpdateEnvelopeStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update envelope recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessRolesSortingKey"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ApplicationRoleSortingKey"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PolicySortingKey"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateTemplateAutomaticRecipientRequest"},{"$ref":"#/components/schemas/CreateTemplateStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for create template recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/TemplateStandardRecipientResponse"},{"$ref":"#/components/schemas/TemplateAutomaticRecipientResponse"}],"description":"Detailed representation of a recipient. Base for polymorphic response."},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/UpdateTemplateAutomaticRecipientRequest"},{"$ref":"#/components/schemas/UpdateTemplateStandardRecipientRequest"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base record for update template recipient requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserSortingKey"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserGroupsSortingKey"},"id":"schema_29"}},"exampleStore":{"paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example":{"value":{"languages":[{"code":"en","name":"English"},{"code":"it","name":"Italian"}]},"id":"paths/~1api~1v1~1languages/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example":{"value":{"countries":[{"code":"US","name":"United States"},{"code":"IT","name":"Italy"}]},"id":"paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example":{"value":{"timeZones":[{"code":"Europe/Berlin","name":"(UTC+01:00) Berlin"},{"code":"Etc/UTC","name":"(UTC) Coordinated Universal Time"}]},"id":"paths/~1api~1v1~1timezones/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example":{"value":{"dateTimeFormats":[{"code":"dd/MM/yyyy | HH:mm"},{"code":"yyyy-MM-dd | HH:mm"}]},"id":"paths/~1api~1v1~1datetime-formats/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example":{"value":{"bulkEnvelopes":[{"id":"00000000-0000-0000-0000-000000000001","name":"Bulk contract for onboarding","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","sentAt":null}],"pagination":{"page":1,"pageSize":50,"totalCount":1}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Bulk contract for Q1 campaign","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:02.9913843+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Bulk contract for Q1 campaign","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Bulk contract for Q1 campaign","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:02.9914574+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades","afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000001"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Bulk contract for onboarding","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:02.9960751+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Bulk contract for onboarding","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Bulk contract for onboarding","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:02.9971942+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Cades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/get/responses/200/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Updated bulk contract name","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.0006848+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Updated bulk contract name","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi","fileRestrictedVisibility":false},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Updated bulk contract name","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.0007414+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades","afterSendRedirectUrl":"https://example.com/bulk-envelope-sent"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}/put/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example":{"value":{"envelopes":[{"id":"00000000-0000-0000-0000-000000000001","name":"Contract for Mario Rossi","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","sentAt":null},{"id":"00000000-0000-0000-0000-000000000002","name":"Contract for Anna Bianchi","status":"InProgress","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-02T12:00:00+00:00","sentAt":"2025-01-02T12:00:00+00:00"}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1envelopes/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000020"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example":{"value":{"documentClass":{"id":"96b3bcea-384e-46f4-af32-d66ea7b42d10","name":"Contract","metadata":[{"type":"NumberType","value":100.9,"id":"c51ce27a-7a7b-4bbf-9f97-9fec418b5fa4","name":"Amount"},{"type":"StringType","value":"New contract","id":"dd96ba7b-a489-4fd5-9d4b-3fed71ec127e","name":"Title"},{"type":"DateType","value":"2026-05-20","id":"a04c0137-e059-4c22-b3df-9577293a5b69","name":"SignDate"},{"type":"ListOptionType","value":"4ea6337b-84d6-4506-b3cb-7b9171f9fb92","id":"77d0be26-a5fe-4d62-95a1-008e6eeb7561","name":"ContractType"}]},"restrictedVisibilityRecipientIds":["74393109-8a08-41ae-b1d3-203a7b06f544","a5bbd7ef-761e-48e8-86dc-0683275c12ac"]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example":{"value":{"documentClass":{"id":"6edd889f-1955-49d4-8f2d-23b729ef14e1","metadata":[{"type":"NumberType","value":100.9,"id":"c8189359-9755-4a5f-8640-abddd3591c70"},{"type":"StringType","value":"New contract","id":"3a59b351-a19a-458c-9c55-51e0bf9f3ca6"},{"type":"DateType","value":"2026-05-20","id":"6ddbb3c2-ee23-4763-849c-77c68c225eae"},{"type":"ListOptionType","value":"9e63b394-d0a6-4beb-9c2e-36d77f24abd1","id":"d0236540-796a-4a00-8b29-f234fee4cd75"}]}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":false,"batchGroup":null,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":"00000000-0000-0000-0000-000000000001","stageId":null,"sortOrder":1,"source":"UserDefined"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - ClickToSign","summary":"Signature - ClickToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DrawToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - DrawToSign","summary":"Signature - DrawToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"TypeToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - TypeToSign","summary":"Signature - TypeToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - LocalCertificate","summary":"Signature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - DisposableCertificate","summary":"Signature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"BiometricSignature"}],"required":true,"batchGroup":"group1","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - Biometric","summary":"Signature - Biometric","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - RemoteCertificate","summary":"Signature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"OneTimePasswordSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - OneTimePassword","summary":"Signature - OneTimePassword","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - Plugin","summary":"Signature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"AutomaticSignature"}],"required":true,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Signature - AutomaticSignature","summary":"Signature - AutomaticSignature","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"InvisibleSignature - LocalCertificate","summary":"InvisibleSignature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"InvisibleSignature - DisposableCertificate","summary":"InvisibleSignature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"InvisibleSignature - RemoteCertificate","summary":"InvisibleSignature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"id":"sig1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"InvisibleSignature - Plugin","summary":"InvisibleSignature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"StringType","value":"Default text","password":false,"multiline":false,"maxLength":100},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"TextInput - String","summary":"TextInput - String","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"DateType","value":"2025-12-31","format":"dd.MM.yyyy","minValue":"2025-01-01","maxValue":"2026-12-31"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"TextInput - Date","summary":"TextInput - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"NumberType","value":42.51,"thousandsSeparator":"Point","decimalSeparator":"Comma","symbol":{"value":"€","position":"Start"},"decimalPlaces":2,"minValue":10.25,"maxValue":1000.78},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"TextInput - Number","summary":"TextInput - Number","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"PhoneNumberType","value":"+393331234567","format":"InternationalLeadingPlus"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"TextInput - PhoneNumber","summary":"TextInput - PhoneNumber","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"TimeType","value":"14:30:00","format":"HH:mm","minValue":"08:00:00","maxValue":"18:00:00"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"TextInput - Time","summary":"TextInput - Time","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox":{"value":{"tasks":[{"field":{"fieldType":"Checkbox","checked":true,"value":"yes","readOnly":false,"required":false,"positionX":50,"positionY":300,"width":20,"height":20,"page":1,"id":"chk1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Checkbox","summary":"Checkbox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton":{"value":{"tasks":[{"field":{"fieldType":"RadioButton","groupName":"group1","checked":false,"readOnly":false,"value":"option1","required":false,"positionX":100,"positionY":200,"width":20,"height":20,"page":1,"id":"rb1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"RadioButton","summary":"RadioButton","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown":{"value":{"tasks":[{"field":{"fieldType":"DropDown","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"readOnly":false,"required":false,"positionX":50,"positionY":400,"width":150,"height":30,"page":1,"id":"dd1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"DropDown","summary":"DropDown","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox":{"value":{"tasks":[{"field":{"fieldType":"ListBox","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"multiselect":true,"readOnly":false,"required":false,"positionX":50,"positionY":500,"width":150,"height":80,"page":1,"id":"lb1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"ListBox","summary":"ListBox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment":{"value":{"tasks":[{"field":{"fieldType":"Attachment","required":false,"positionX":50,"positionY":600,"width":100,"height":30,"page":1,"id":"att1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Attachment","summary":"Attachment","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Text","value":"Default text"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - Text","summary":"Annotation - Text","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Date","format":"dd.MM.yyyy"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - Date","summary":"Annotation - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FullName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - FullName","summary":"Annotation - FullName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FirstName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - FirstName","summary":"Annotation - FirstName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"LastName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - LastName","summary":"Annotation - LastName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Initials"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - Initials","summary":"Annotation - Initials","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Email"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Annotation - Email","summary":"Annotation - Email","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link":{"value":{"tasks":[{"field":{"fieldType":"Link","reference":"https://example.com","positionX":50,"positionY":700,"width":150,"height":30,"page":1,"id":"lnk1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Link","summary":"Link","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"FileReadConfirmation","required":false,"id":"frc1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"FileReadConfirmation","summary":"FileReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"PageReadConfirmation","required":false,"page":1,"id":"prc1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"PageReadConfirmation","summary":"PageReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"AreaReadConfirmation","required":false,"positionX":50,"positionY":250,"width":200,"height":100,"page":1,"id":"arc1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"AreaReadConfirmation","summary":"AreaReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval":{"value":{"tasks":[{"field":{"fieldType":"Approval","required":false,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"app1"},"recipientId":null,"stageId":null,"sortOrder":1}]},"key":"Approval","summary":"Approval","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer","mode":"Bulk"},{"id":"00000000-0000-0000-0000-000000000011","name":"Stage 2","sortOrder":2,"requiredRecipientCompletions":1,"type":"Signer","mode":"Standard"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer":{"value":{"type":"Signer","mode":"Standard","name":"Signer Stage","requiredRecipientCompletions":1},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"type":"CarbonCopy","mode":"Standard","name":"CarbonCopy Stage"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer":{"value":{"type":"Viewer","mode":"Standard","name":"Viewer Stage","requiredRecipientCompletions":1},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","mode":"Standard","name":"Automatic Stage"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver":{"value":{"type":"Approver","mode":"Standard","name":"Approver Stage","requiredRecipientCompletions":1},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer":{"value":{"type":"Signer","mode":"Bulk","name":"Bulk Stage"},"key":"Bulk Signer","summary":"Bulk Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver":{"value":{"type":"Approver","mode":"Bulk","name":"Bulk Stage"},"key":"Bulk Approver","summary":"Bulk Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/requestBody/content/application~1json/examples/Bulk Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer","mode":"Bulk","recipients":[{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"id":"00000000-0000-0000-0000-000000000100"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer":{"value":{"name":"Signer Stage","requiredRecipientCompletions":1,"type":"Signer"},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"name":"CarbonCopy Stage","requiredRecipientCompletions":1,"type":"CarbonCopy"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer":{"value":{"name":"Viewer Stage","requiredRecipientCompletions":1,"type":"Viewer"},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"name":"Automatic Stage","requiredRecipientCompletions":1,"type":"Automatic"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver":{"value":{"name":"Approver Stage","requiredRecipientCompletions":1,"type":"Approver"},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000100"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000100","languageCode":"en","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":null,"signatureConfiguration":null,"personalMessage":"Please review and sign the attached contract.","metadata":null,"signatureReason":"I agree to the terms.","isSignatureReasonEditable":false},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1bulk-envelopes~1{bulkEnvelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example":{"value":{"documentClasses":[{"id":"a975adef-8c62-4aec-9f0e-e3a428de04f8","name":"Contract"},{"id":"42131078-1d69-4a15-9d40-0acbe72ca0d4","name":"Invoice"}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example":{"value":{"name":"Contracts","description":"Document class for contracts","metadata":[{"id":"d4d97f11-d33d-4352-b75f-19015e186949","sortOrder":1,"required":true},{"id":"8b190436-0990-48b6-ae15-54ff6caddddf","sortOrder":2,"required":true},{"id":"ad48c6bc-de30-44e1-a32d-6e31332e96d0","sortOrder":3,"required":false}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example":{"value":{"id":"e40d5ec9-0689-4648-bf15-8332d937fa9b"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example":{"value":{"id":"3937bfba-3090-49e4-951c-e7af9ef40812","name":"Contract","description":"Standard contract document class","metadata":[{"type":"StringType","id":"50ffb395-4f60-4f34-ad47-8d862bcf363d","name":"SignerName","required":true,"sortOrder":1},{"type":"DateType","id":"7bb0a649-6256-4e22-98b7-eeed896f8288","name":"SignatureDate","required":false,"sortOrder":2},{"type":"NumberType","id":"69d32878-2972-4ee5-9aad-4672f37290f0","name":"TotalAmount","required":true,"sortOrder":3},{"type":"ListOptionType","options":[{"id":"ccdfeacd-954d-4d8d-98dd-43693b87864a","value":"Invoice","parentId":null},{"id":"0bdde37c-a06d-4881-a1d7-99194abc3364","value":"NDA","parentId":null}],"parentId":null,"id":"87601520-f6be-48c8-b7a8-6bd8839fafd0","name":"ContractType","required":true,"sortOrder":4}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example":{"value":{"name":"Contracts","description":"Document class for contracts","metadata":[{"id":"ba12e5d5-50dc-48c3-afe0-af5a1af6ef6e","sortOrder":1,"required":true},{"id":"63d62ca1-0588-4de0-a465-6c623c0f1462","sortOrder":2,"required":true},{"id":"e6ed43b9-8cc4-454c-85d7-2668b5856dbe","sortOrder":3,"required":false}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-classes~1{documentClassId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example":{"value":{"documentMetadata":[{"type":"StringType","id":"6b6014ef-9578-4478-8530-edd533a12556","name":"ContractNumber"},{"type":"NumberType","id":"2a5dbed4-3478-436f-b231-1b413d5d2af9","name":"Amount"},{"type":"DateType","id":"244e2c67-dca7-410f-8584-6abf53419afb","name":"SignatureDate"},{"type":"ListOptionType","parentId":null,"options":[{"id":"35dfedc0-e161-4ef9-adca-c8db0ae225d9","value":"Invoice","parentId":null},{"id":"7c1f74f2-2632-4062-809a-3face031ea1d","value":"NDA","parentId":null}],"id":"a7c967ce-9246-4345-9ac5-376b30162c93","name":"ContractType"}],"pagination":{"page":1,"pageSize":20,"totalCount":4}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType":{"value":{"type":"StringType","name":"ContractNumber"},"key":"StringType","summary":"StringType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/StringType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType":{"value":{"type":"NumberType","name":"TotalAmount"},"key":"NumberType","summary":"NumberType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/NumberType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType":{"value":{"type":"DateType","name":"SignatureDate"},"key":"DateType","summary":"DateType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/DateType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType":{"value":{"options":[{"value":"Invoice","parentId":"a3678500-66b3-494c-9eb2-4f8e302f819d"},{"value":"NDA","parentId":"e69d376b-0cbf-4182-bc31-abe1ad284fbe"}],"parentId":"44d1e5d5-5747-42e5-ab4c-6be2e903cc1d","type":"ListOptionType","name":"ContractType"},"key":"ListOptionType","summary":"ListOptionType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata/post/requestBody/content/application~1json/examples/ListOptionType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType":{"value":{"type":"StringType","name":"ContractNumber"},"key":"StringType","summary":"StringType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/StringType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType":{"value":{"type":"NumberType","name":"TotalAmount"},"key":"NumberType","summary":"NumberType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/NumberType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType":{"value":{"type":"DateType","name":"SignatureDate"},"key":"DateType","summary":"DateType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/DateType"},"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType":{"value":{"options":[{"value":"Invoice","parentId":"b5aeb01b-851a-4fe9-b21e-5100ed4f65ac"},{"value":"NDA"}],"parentId":"f2e246a5-9dfa-464d-b9b1-3a809c2d7795","type":"ListOptionType","name":"ContractType"},"key":"ListOptionType","summary":"ListOptionType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1document-metadata~1{metadataId}/put/requestBody/content/application~1json/examples/ListOptionType"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example":{"value":{"envelopes":[{"id":"00000000-0000-0000-0000-000000000001","name":"Contract for Mario Rossi","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","sentAt":null}],"pagination":{"page":1,"pageSize":50,"totalCount":1}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Contract for Mario Rossi","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.1763097+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Contract for Mario Rossi","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Contract for Mario Rossi","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.1763703+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000001"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Contract for Mario Rossi","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.1810163+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent","bulkEnvelopeId":null},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Contract for Mario Rossi","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent","bulkEnvelopeId":null},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Contract for Mario Rossi","status":"Draft","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.1810946+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}],"sentAt":null,"qualifiedTimeStamp":true,"signatureFormat":"Cades","signatureReason":"Approved by Mario Rossi","statusChangeReason":"Document no longer required","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent","bulkEnvelopeId":null},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/get/responses/200/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Updated contract name","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.184352+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Updated contract name","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi","fileRestrictedVisibility":false},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Updated contract name","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.1844105+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}/put/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example":{"value":{"newExpirationDate":"2026-11-18T14:00:03.1899635+00:00"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1resume/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example":{"value":{"reason":"No longer needed"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1cancel/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000050"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1clone/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example":{"value":{"compliant":true},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1verify-policies/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example":{"value":{"events":[{"id":"00000000-0000-0000-0000-000000000040","type":"EnvelopeSent","actor":{"email":"owner@example.com"},"occurredAt":"2025-01-02T12:00:00+00:00"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1events/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example":{"value":{"nextRecipientLinks":[{"recipient":{"id":"00000000-0000-0000-0000-000000000100","givenName":"Mario","surname":"Rossi","type":"Signer"},"link":"https://sign.example.com/recipient/00000000-0000-0000-0000-000000000100"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1next-recipient-links/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example":{"value":{"artifacts":[{"id":"00000000-0000-0000-0000-000000000030","name":"contract-signed.pdf","type":"CompletedFile"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1artifacts/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"contract.pdf","sortOrder":1}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000020"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example":{"value":{"documentClass":{"id":"3982311f-cec1-42b8-8799-6c304aa098ea","name":"Contract","metadata":[{"type":"NumberType","value":100.9,"id":"7c1a1484-2325-410e-ad03-a04470f721f5","name":"Amount"},{"type":"StringType","value":"New contract","id":"449d3fea-8ea2-451f-8f6e-85433d6892a1","name":"Title"},{"type":"DateType","value":"2026-05-20","id":"68142184-b184-4ca1-9edf-2a8a745e56ad","name":"SignDate"},{"type":"ListOptionType","value":"d0e130ea-0531-4b9b-a3ba-e3ae1d2cee14","id":"723e64c6-5c5a-4d8a-aefa-95be4c897c0b","name":"ContractType"}]},"restrictedVisibilityRecipientIds":["9cb9ee46-7932-440f-987f-3bf9e8174699","bfb6d84c-50fd-4b9a-a17a-a6b7fcbcce47"]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example":{"value":{"documentClass":{"id":"84a8b8bc-cfa7-4969-ad4d-8144b6fdcc16","metadata":[{"type":"NumberType","value":100.9,"id":"d0b19ac7-9764-4993-8161-095f7209b392"},{"type":"StringType","value":"New contract","id":"3180df92-f91b-4386-b485-788724b42e1f"},{"type":"DateType","value":"2026-05-20","id":"b6bd937a-292d-4083-968e-a43ca25f94f8"},{"type":"ListOptionType","value":"bb477fc0-9584-413b-bcf8-f5b7d456f260","id":"46d934f3-352e-42c0-b349-d30a47c59930"}]}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":false,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":"00000000-0000-0000-0000-000000000001","sortOrder":1,"source":"UserDefined"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - ClickToSign","summary":"Signature - ClickToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DrawToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - DrawToSign","summary":"Signature - DrawToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"TypeToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - TypeToSign","summary":"Signature - TypeToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - LocalCertificate","summary":"Signature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - DisposableCertificate","summary":"Signature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"BiometricSignature"}],"required":true,"batchGroup":"group1","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - Biometric","summary":"Signature - Biometric","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - RemoteCertificate","summary":"Signature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"OneTimePasswordSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - OneTimePassword","summary":"Signature - OneTimePassword","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - Plugin","summary":"Signature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"AutomaticSignature"}],"required":true,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - AutomaticSignature","summary":"Signature - AutomaticSignature","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - LocalCertificate","summary":"InvisibleSignature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - DisposableCertificate","summary":"InvisibleSignature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - RemoteCertificate","summary":"InvisibleSignature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - Plugin","summary":"InvisibleSignature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"StringType","value":"Default text","password":false,"multiline":false,"maxLength":100},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - String","summary":"TextInput - String","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"DateType","value":"2025-12-31","format":"dd.MM.yyyy","minValue":"2025-01-01","maxValue":"2026-12-31"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Date","summary":"TextInput - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"NumberType","value":42.51,"thousandsSeparator":"Point","decimalSeparator":"Comma","symbol":{"value":"€","position":"Start"},"decimalPlaces":2,"minValue":10.25,"maxValue":1000.78},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Number","summary":"TextInput - Number","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"PhoneNumberType","value":"+393331234567","format":"InternationalLeadingPlus"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - PhoneNumber","summary":"TextInput - PhoneNumber","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"TimeType","value":"14:30:00","format":"HH:mm","minValue":"08:00:00","maxValue":"18:00:00"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Time","summary":"TextInput - Time","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox":{"value":{"tasks":[{"field":{"fieldType":"Checkbox","checked":true,"value":"yes","readOnly":false,"required":false,"positionX":50,"positionY":300,"width":20,"height":20,"page":1,"id":"chk1"},"recipientId":null,"sortOrder":1}]},"key":"Checkbox","summary":"Checkbox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton":{"value":{"tasks":[{"field":{"fieldType":"RadioButton","groupName":"group1","checked":false,"readOnly":false,"value":"option1","required":false,"positionX":100,"positionY":200,"width":20,"height":20,"page":1,"id":"rb1"},"recipientId":null,"sortOrder":1}]},"key":"RadioButton","summary":"RadioButton","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown":{"value":{"tasks":[{"field":{"fieldType":"DropDown","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"readOnly":false,"required":false,"positionX":50,"positionY":400,"width":150,"height":30,"page":1,"id":"dd1"},"recipientId":null,"sortOrder":1}]},"key":"DropDown","summary":"DropDown","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox":{"value":{"tasks":[{"field":{"fieldType":"ListBox","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"multiselect":true,"readOnly":false,"required":false,"positionX":50,"positionY":500,"width":150,"height":80,"page":1,"id":"lb1"},"recipientId":null,"sortOrder":1}]},"key":"ListBox","summary":"ListBox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment":{"value":{"tasks":[{"field":{"fieldType":"Attachment","required":false,"positionX":50,"positionY":600,"width":100,"height":30,"page":1,"id":"att1"},"recipientId":null,"sortOrder":1}]},"key":"Attachment","summary":"Attachment","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Text","value":"Default text"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Text","summary":"Annotation - Text","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Date","format":"dd.MM.yyyy"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Date","summary":"Annotation - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FullName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - FullName","summary":"Annotation - FullName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FirstName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - FirstName","summary":"Annotation - FirstName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"LastName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - LastName","summary":"Annotation - LastName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Initials"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Initials","summary":"Annotation - Initials","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Email"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Email","summary":"Annotation - Email","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link":{"value":{"tasks":[{"field":{"fieldType":"Link","reference":"https://example.com","positionX":50,"positionY":700,"width":150,"height":30,"page":1,"id":"lnk1"},"recipientId":null,"sortOrder":1}]},"key":"Link","summary":"Link","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"FileReadConfirmation","required":false,"id":"frc1"},"recipientId":null,"sortOrder":1}]},"key":"FileReadConfirmation","summary":"FileReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"PageReadConfirmation","required":false,"page":1,"id":"prc1"},"recipientId":null,"sortOrder":1}]},"key":"PageReadConfirmation","summary":"PageReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"AreaReadConfirmation","required":false,"positionX":50,"positionY":250,"width":200,"height":100,"page":1,"id":"arc1"},"recipientId":null,"sortOrder":1}]},"key":"AreaReadConfirmation","summary":"AreaReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval":{"value":{"tasks":[{"field":{"fieldType":"Approval","required":false,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"app1"},"recipientId":null,"sortOrder":1}]},"key":"Approval","summary":"Approval","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer":{"value":{"type":"Signer","name":"Signer Stage","requiredRecipientCompletions":1},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"type":"CarbonCopy","name":"CarbonCopy Stage"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer":{"value":{"type":"Viewer","name":"Viewer Stage","requiredRecipientCompletions":1},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","name":"Automatic Stage"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver":{"value":{"type":"Approver","name":"Approver Stage","requiredRecipientCompletions":1},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer","recipients":[{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"id":"00000000-0000-0000-0000-000000000100"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer":{"value":{"name":"Signer Stage","requiredRecipientCompletions":1,"type":"Signer"},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"name":"CarbonCopy Stage","requiredRecipientCompletions":1,"type":"CarbonCopy"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer":{"value":{"name":"Viewer Stage","requiredRecipientCompletions":1,"type":"Viewer"},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"name":"Automatic Stage","requiredRecipientCompletions":1,"type":"Automatic"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver":{"value":{"name":"Approver Stage","requiredRecipientCompletions":1,"type":"Approver"},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000100"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached contract.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example":{"value":{"enabled":true,"overridable":false,"agreements":[{"language":"en","title":"Terms of Service","body":"By signing this document you agree to our terms."},{"language":"it","title":"Termini di Servizio","body":"Firmando questo documento accetti i nostri termini."}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example":{"value":{"enabled":true,"overridable":false,"agreements":[{"language":"en","title":"Terms of Service","body":"By signing this document you agree to our terms."},{"language":"it","title":"Termini di Servizio","body":"Firmando questo documento accetti i nostri termini."}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1envelope~1agreement/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example":{"value":{"name":"name"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example":{"value":{"languages":["de","en","it"]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example":{"value":{"languages":["en","it","de"]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1languages/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example":{"value":{"timeZone":"Europe/Berlin","dateTimeFormat":"dd/MM/yyyy | HH:mm","language":"en"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example":{"value":{"timeZone":"Europe/Berlin","dateTimeFormat":"dd/MM/yyyy | HH:mm","language":"en"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1general~1regional/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"None"}},"key":"Mandatory authentication - None","summary":"Mandatory authentication - None","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - None"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"Any"}},"key":"Mandatory authentication - Any","summary":"Mandatory authentication - Any","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - Any"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"AccessCode"}},"key":"Mandatory authentication - AccessCode","summary":"Mandatory authentication - AccessCode","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - AccessCode"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"OneTimePassword"}},"key":"Mandatory authentication - OneTimePassword","summary":"Mandatory authentication - OneTimePassword","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OneTimePassword"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"OAuth","oAuthProviderId":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}},"key":"Mandatory authentication - OAuth","summary":"Mandatory authentication - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/get/responses/200/content/application~1json/examples/Mandatory authentication - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"None"}},"key":"Mandatory authentication - None","summary":"Mandatory authentication - None","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - None"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"Any"}},"key":"Mandatory authentication - Any","summary":"Mandatory authentication - Any","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - Any"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"AccessCode"}},"key":"Mandatory authentication - AccessCode","summary":"Mandatory authentication - AccessCode","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - AccessCode"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"OneTimePassword"}},"key":"Mandatory authentication - OneTimePassword","summary":"Mandatory authentication - OneTimePassword","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OneTimePassword"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth":{"value":{"sendCompletedFileToAllRecipients":true,"warnIfRecipientsHaveNoFields":true,"authentications":{"accessCode":true,"oneTimePassword":{"enabled":true}},"recipientDelegation":"allowedEnabled","mandatoryAuthentication":{"authentication":"OAuth","oAuthProviderId":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}},"key":"Mandatory authentication - OAuth","summary":"Mandatory authentication - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1recipient/patch/requestBody/content/application~1json/examples/Mandatory authentication - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example":{"value":{"defaultSignatureType":"ClickToSign","auditTrailMode":"Standard","timestamp":{"url":"https://timestamp.example.com","username":"tsa-user","hashAlgorithm":"SHA-256"},"disposableCertificate":{"showDisclaimerBeforeCertificateRequest":true,"sendDisposableDisclaimerDocumentNotifications":true,"lraId":"LRA-001","user":"lra-user","disposableType":"Disposable"},"defaultSignatureLayoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example":{"value":{"defaultSignatureType":"ClickToSign","auditTrailMode":"Standard","timestamp":{"url":"https://timestamp.example.com","username":"tsa-user","password":"P@ssw0rd!","hashAlgorithm":"SHA-256"},"disposableCertificate":{"lraId":"LRA-001","user":"lra-user","password":"P@ssw0rd!","disposableType":"Disposable","showDisclaimerBeforeCertificateRequest":true,"sendDisposableDisclaimerDocumentNotifications":true}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example":{"value":{"layouts":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Default layout"},{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","name":"Compact layout"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example":{"value":{"name":"compact-layout","fields":{"signerName":{"visible":true},"signerEmail":{"visible":true},"ipAddress":{"visible":false},"reason":{"visible":true},"dateTime":{"visible":true,"format":"dd/MM/yyyy | HH:mm","localTimezone":false,"timezone":"Europe/Berlin"},"customText":{"visible":false}}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example":{"value":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example":{"value":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"compact-layout","fields":{"signerName":{"visible":true},"signerEmail":{"visible":true},"ipAddress":{"visible":false},"reason":{"visible":true},"dateTime":{"visible":true,"format":"dd/MM/yyyy | HH:mm","localTimezone":false,"timezone":"Europe/Berlin"},"customText":{"visible":false}},"image":null},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example":{"value":{"name":"compact-layout","fields":{"signerName":{"visible":true},"signerEmail":{"visible":true},"ipAddress":{"visible":false},"reason":{"visible":true},"dateTime":{"visible":true,"format":"dd/MM/yyyy | HH:mm","localTimezone":false,"timezone":"Europe/Berlin"},"customText":{"visible":false}}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1signature~1layouts~1{layoutId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example":{"value":{"items":[{"id":"648673bd-1a8d-4cc6-a5b9-b626fcc58d79","name":"Approver","description":"Approves envelopes before completion."},{"id":"77574b95-24c8-420d-9b08-9cd22b8cc75a","name":"Reviewer","description":null}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example":{"value":{"name":"Approver","description":"Approves envelopes before completion."},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example":{"value":{"id":"ced2dd3e-fade-447d-8fcb-118d0a4fb754"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example":{"value":{"name":"Approver","description":"Approves envelopes before completion."},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1business-roles~1{businessRoleId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example":{"value":{"name":"Contract Reviewer","permissions":[{"entity":"Envelope","action":"Read"},{"entity":"Template","action":"Read"}],"description":"Can read envelopes and templates"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example":{"value":{"name":"Contract Reviewer","permissions":[{"entity":"Envelope","action":"Read"},{"entity":"Template","action":"Read"}],"description":"Can read envelopes and templates"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1settings~1user~1application-roles~1{applicationRoleId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example":{"value":{"policies":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Standard signing policy","isActive":true,"description":"Policy applied to all standard signing envelopes"},{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","name":"Approval policy","isActive":false,"description":null}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)":{"value":{"name":"Standard signing policy","isActive":true,"conditions":[],"actions":[]},"key":"minimal (no conditions or actions)","summary":"minimal (no conditions or actions)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/minimal (no conditions or actions)"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType":{"value":{"name":"Invoice policy","isActive":true,"description":"Applies to invoice documents","documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"StringType","value":"Invoice","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"actions":[]},"key":"condition - StringType","summary":"condition - StringType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - StringType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType":{"value":{"name":"High-value contract policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"GreaterThan","sortOrder":1,"metadata":{"type":"NumberType","value":1000,"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}}],"actions":[]},"key":"condition - NumberType","summary":"condition - NumberType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - NumberType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType":{"value":{"name":"Due-date policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"LessThan","sortOrder":1,"metadata":{"type":"DateType","value":"2026-01-01","id":"d290f1ee-6c54-4b01-90e6-d701748f0851"}}],"actions":[]},"key":"condition - DateType","summary":"condition - DateType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - DateType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType":{"value":{"name":"Contract category policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"ListOptionType","value":"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d","id":"e8c9d2b4-9f3a-4b1d-8b2e-6c8a1f2d3e4b"}}],"actions":[]},"key":"condition - ListOptionType","summary":"condition - ListOptionType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/condition - ListOptionType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static":{"value":{"name":"Standard signing policy","isActive":true,"description":"Policy applied to all standard signing envelopes","conditions":[],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Signer Stage","type":"Signer","requiredRecipientCompletions":1},"recipientSource":{"type":"Static","recipients":[{"givenName":"Jane","surname":"Doe","email":"jane.doe@example.com","phoneNumber":"+1 555 0100"}]},"sortOrder":1}]},"key":"action - recipientSource Static","summary":"action - recipientSource Static","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Static"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic":{"value":{"name":"Approval policy","isActive":true,"conditions":[],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Approval Stage","type":"Approver","requiredRecipientCompletions":1},"recipientSource":{"type":"Dynamic","userGroupId":"9b2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f","businessRoleId":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"},"sortOrder":1}]},"key":"action - recipientSource Dynamic","summary":"action - recipientSource Dynamic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/action - recipientSource Dynamic"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)":{"value":{"name":"High-value invoice approval policy","isActive":true,"description":"Routes high-value invoices to an approver before signing","documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"StringType","value":"Invoice","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},{"operator":"GreaterThan","sortOrder":2,"metadata":{"type":"NumberType","value":1000,"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}}],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Approval Stage","type":"Approver","requiredRecipientCompletions":1},"recipientSource":{"type":"Dynamic","userGroupId":"9b2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f","businessRoleId":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"},"sortOrder":1},{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Signer Stage","type":"Signer","requiredRecipientCompletions":2},"recipientSource":{"type":"Static","recipients":[{"givenName":"Jane","surname":"Doe","email":"jane.doe@example.com","phoneNumber":"+1 555 0100"}]},"sortOrder":2}]},"key":"complete (conditions and actions)","summary":"complete (conditions and actions)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies/post/requestBody/content/application~1json/examples/complete (conditions and actions)"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example":{"value":{"id":"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d","name":"Standard signing policy","isActive":true,"description":"Policy applied to all standard signing envelopes","documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"id":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","operator":"Equals","sortOrder":0,"metadata":{"type":"StringType","value":"Invoice","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},{"id":"2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e","operator":"GreaterThan","sortOrder":1,"metadata":{"type":"NumberType","value":1000,"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}},{"id":"3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f","operator":"LessThan","sortOrder":2,"metadata":{"type":"DateType","value":"2026-01-01","id":"d290f1ee-6c54-4b01-90e6-d701748f0851"}},{"id":"4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a","operator":"Equals","sortOrder":3,"metadata":{"type":"ListOptionType","value":"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d","id":"e8c9d2b4-9f3a-4b1d-8b2e-6c8a1f2d3e4b"}}],"actions":[{"id":"5e6f7a8b-9c0d-4e1f-2a3b-4c5d6e7f8a9b","type":"AddEnvelopeStageConfiguration","stage":{"name":"Signer Stage","type":"Signer","requiredRecipientCompletions":1},"recipientSource":{"type":"Static","recipients":[{"givenName":"Jane","surname":"Doe","email":"jane.doe@example.com","phoneNumber":"+1 555 0100"}]},"sortOrder":0},{"id":"6f7a8b9c-0d1e-4f2a-3b4c-5d6e7f8a9b0c","type":"AddEnvelopeStageConfiguration","stage":{"name":"Approval Stage","type":"Approver","requiredRecipientCompletions":1},"recipientSource":{"type":"Dynamic","userGroupId":"7f8a9b0c-1d2e-4f3a-4b5c-6d7e8f9a0b1c","businessRoleId":"8a9b0c1d-2e3f-4a4b-5c6d-7e8f9a0b1c2d"},"sortOrder":1}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)":{"value":{"name":"Standard signing policy","isActive":true,"conditions":[],"actions":[]},"key":"minimal (no conditions or actions)","summary":"minimal (no conditions or actions)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/minimal (no conditions or actions)"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType":{"value":{"name":"Invoice policy","isActive":true,"description":"Applies to invoice documents","documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"StringType","value":"Invoice","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"actions":[]},"key":"condition - StringType","summary":"condition - StringType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - StringType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType":{"value":{"name":"High-value contract policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"GreaterThan","sortOrder":1,"metadata":{"type":"NumberType","value":1000,"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}}],"actions":[]},"key":"condition - NumberType","summary":"condition - NumberType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - NumberType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType":{"value":{"name":"Due-date policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"LessThan","sortOrder":1,"metadata":{"type":"DateType","value":"2026-01-01","id":"d290f1ee-6c54-4b01-90e6-d701748f0851"}}],"actions":[]},"key":"condition - DateType","summary":"condition - DateType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - DateType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType":{"value":{"name":"Contract category policy","isActive":true,"documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"ListOptionType","value":"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d","id":"e8c9d2b4-9f3a-4b1d-8b2e-6c8a1f2d3e4b"}}],"actions":[]},"key":"condition - ListOptionType","summary":"condition - ListOptionType","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/condition - ListOptionType"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static":{"value":{"name":"Standard signing policy","isActive":true,"description":"Policy applied to all standard signing envelopes","conditions":[],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Signer Stage","type":"Signer","requiredRecipientCompletions":1},"recipientSource":{"type":"Static","recipients":[{"givenName":"Jane","surname":"Doe","email":"jane.doe@example.com","phoneNumber":"+1 555 0100"}]},"sortOrder":1}]},"key":"action - recipientSource Static","summary":"action - recipientSource Static","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Static"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic":{"value":{"name":"Approval policy","isActive":true,"conditions":[],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Approval Stage","type":"Approver","requiredRecipientCompletions":1},"recipientSource":{"type":"Dynamic","userGroupId":"9b2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f","businessRoleId":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"},"sortOrder":1}]},"key":"action - recipientSource Dynamic","summary":"action - recipientSource Dynamic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/action - recipientSource Dynamic"},"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)":{"value":{"name":"High-value invoice approval policy","isActive":true,"description":"Routes high-value invoices to an approver before signing","documentClassId":"6ecd8c99-4036-403d-bf84-cf8400f67836","conditions":[{"operator":"Equals","sortOrder":1,"metadata":{"type":"StringType","value":"Invoice","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},{"operator":"GreaterThan","sortOrder":2,"metadata":{"type":"NumberType","value":1000,"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}}],"actions":[{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Approval Stage","type":"Approver","requiredRecipientCompletions":1},"recipientSource":{"type":"Dynamic","userGroupId":"9b2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f","businessRoleId":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"},"sortOrder":1},{"type":"AddEnvelopeStageConfiguration","stage":{"name":"Signer Stage","type":"Signer","requiredRecipientCompletions":2},"recipientSource":{"type":"Static","recipients":[{"givenName":"Jane","surname":"Doe","email":"jane.doe@example.com","phoneNumber":"+1 555 0100"}]},"sortOrder":2}]},"key":"complete (conditions and actions)","summary":"complete (conditions and actions)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1policies~1{policyId}/put/requestBody/content/application~1json/examples/complete (conditions and actions)"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example":{"value":{"templates":[{"id":"00000000-0000-0000-0000-000000000001","name":"Standard NDA template","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00"}],"pagination":{"page":1,"pageSize":50,"totalCount":1}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Standard NDA template","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3574952+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Standard NDA template","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Standard NDA template","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3575505+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000001"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Standard NDA template","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3629867+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"nda.pdf","sortOrder":1}],"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Standard NDA template","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"nda.pdf","sortOrder":1}],"qualifiedTimeStamp":true,"signatureFormat":"Pades","signatureReason":"Approved by Mario Rossi","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES":{"value":{"id":"00000000-0000-0000-0000-000000000001","name":"Standard NDA template","createdAt":"2025-01-01T10:00:00+00:00","updatedAt":"2025-01-01T10:00:00+00:00","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3630626+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1}],"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"nda.pdf","sortOrder":1}],"qualifiedTimeStamp":true,"signatureFormat":"Cades","signatureReason":"Approved by Mario Rossi","agreements":null,"fileRestrictedVisibility":false,"afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/get/responses/200/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)":{"value":{"name":"Updated NDA template","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3673258+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":true,"signatureReason":"Approved by Mario Rossi","afterSendRedirectUrl":"https://example.com/envelope-sent"},"key":"PAdES, absolute expiration (default)","summary":"PAdES, absolute expiration (default)","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, absolute expiration (default)"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration":{"value":{"name":"Updated NDA template","expiration":{"mode":"Relative","afterSendInSeconds":604800},"reminder":{"enabled":false,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"qualifiedTimeStamp":false,"signatureReason":"Approved by Mario Rossi"},"key":"PAdES, relative expiration","summary":"PAdES, relative expiration","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/PAdES, relative expiration"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES":{"value":{"name":"Updated NDA template","expiration":{"mode":"Absolute","expiresAt":"2026-12-11T14:00:03.3673869+00:00"},"reminder":{"enabled":true,"firstReminderInDays":5,"resendIntervalInDays":3,"beforeExpirationInDays":2},"signatureFormat":"Cades"},"key":"CAdES","summary":"CAdES","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}/put/requestBody/content/application~1json/examples/CAdES"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example":{"value":{"createdEnvelopeId":"00000000-0000-0000-0000-000000000200"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1create-envelope/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000020","name":"nda.pdf","sortOrder":1}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000020"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example":{"value":{"files":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example":{"value":{"documentClass":{"id":"c854209d-7589-4088-9627-3040ad975178","name":"Contract","metadata":[{"type":"NumberType","value":100.9,"id":"5140a458-6c85-41f3-aed0-87b3b84bb200","name":"Amount"},{"type":"StringType","value":"New contract","id":"fbca9fc4-ab41-43c9-85d1-c895d357ca96","name":"Title"},{"type":"DateType","value":"2026-05-20","id":"aaa366de-e3ce-43c7-aee6-98fca2ec15a8","name":"SignDate"},{"type":"ListOptionType","value":"a2717f1d-44dc-41d2-afa6-9ed7f3952682","id":"61deebc0-a2ca-4872-9f8a-16b4da6425f2","name":"ContractType"}]},"restrictedVisibilityRecipientIds":["5d9e0078-2c40-4d34-8c6c-b621071aca82","5aad6c85-d780-4632-9483-c47b87ed9446"]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example":{"value":{"documentClass":{"id":"d7de23eb-074e-4081-807f-8c1fe6705bcf","metadata":[{"type":"NumberType","value":100.9,"id":"d54926e0-426e-4d68-b992-3f1de0d224d0"},{"type":"StringType","value":"New contract","id":"04eccc60-c219-41be-bdf3-74e051862e70"},{"type":"DateType","value":"2026-05-20","id":"48bad13e-bdc7-4bc1-95c8-f7c2a7528a22"},{"type":"ListOptionType","value":"712dd981-2250-4d64-aa93-18a8b1411439","id":"e1822bdb-f61d-4768-a521-b56c097c8c0f"}]}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":false,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":"00000000-0000-0000-0000-000000000001","sortOrder":1,"source":"UserDefined"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"ClickToSignSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - ClickToSign","summary":"Signature - ClickToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - ClickToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DrawToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - DrawToSign","summary":"Signature - DrawToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DrawToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"TypeToSignSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - TypeToSign","summary":"Signature - TypeToSign","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - TypeToSign"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - LocalCertificate","summary":"Signature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - DisposableCertificate","summary":"Signature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"BiometricSignature"}],"required":true,"batchGroup":"group1","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - Biometric","summary":"Signature - Biometric","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Biometric"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - RemoteCertificate","summary":"Signature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"OneTimePasswordSignature"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - OneTimePassword","summary":"Signature - OneTimePassword","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - OneTimePassword"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"required":true,"batchGroup":"group1","layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - Plugin","summary":"Signature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature":{"value":{"tasks":[{"field":{"fieldType":"Signature","allowedSignatureTypes":[{"signatureType":"AutomaticSignature"}],"required":true,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"Signature - AutomaticSignature","summary":"Signature - AutomaticSignature","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Signature - AutomaticSignature"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"LocalCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - LocalCertificate","summary":"InvisibleSignature - LocalCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - LocalCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"DisposableCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - DisposableCertificate","summary":"InvisibleSignature - DisposableCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - DisposableCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"RemoteCertificateSignature"}],"qualifiedTimeStamp":true,"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - RemoteCertificate","summary":"InvisibleSignature - RemoteCertificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - RemoteCertificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin":{"value":{"tasks":[{"field":{"fieldType":"InvisibleSignature","allowedSignatureTypes":[{"signatureType":"PluginSignature","pluginId":"ArubaGsp"}],"id":"sig1"},"recipientId":null,"sortOrder":1}]},"key":"InvisibleSignature - Plugin","summary":"InvisibleSignature - Plugin","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/InvisibleSignature - Plugin"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"StringType","value":"Default text","password":false,"multiline":false,"maxLength":100},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - String","summary":"TextInput - String","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - String"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"DateType","value":"2025-12-31","format":"dd.MM.yyyy","minValue":"2025-01-01","maxValue":"2026-12-31"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Date","summary":"TextInput - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"NumberType","value":42.51,"thousandsSeparator":"Point","decimalSeparator":"Comma","symbol":{"value":"€","position":"Start"},"decimalPlaces":2,"minValue":10.25,"maxValue":1000.78},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Number","summary":"TextInput - Number","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Number"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"PhoneNumberType","value":"+393331234567","format":"InternationalLeadingPlus"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - PhoneNumber","summary":"TextInput - PhoneNumber","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - PhoneNumber"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time":{"value":{"tasks":[{"field":{"fieldType":"TextInput","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"textInputConfig":{"textInputType":"TimeType","value":"14:30:00","format":"HH:mm","minValue":"08:00:00","maxValue":"18:00:00"},"readOnly":false,"required":true,"positionX":50,"positionY":100,"width":150,"height":30,"page":1,"id":"txt1"},"recipientId":null,"sortOrder":1}]},"key":"TextInput - Time","summary":"TextInput - Time","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/TextInput - Time"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox":{"value":{"tasks":[{"field":{"fieldType":"Checkbox","checked":true,"value":"yes","readOnly":false,"required":false,"positionX":50,"positionY":300,"width":20,"height":20,"page":1,"id":"chk1"},"recipientId":null,"sortOrder":1}]},"key":"Checkbox","summary":"Checkbox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Checkbox"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton":{"value":{"tasks":[{"field":{"fieldType":"RadioButton","groupName":"group1","checked":false,"readOnly":false,"value":"option1","required":false,"positionX":100,"positionY":200,"width":20,"height":20,"page":1,"id":"rb1"},"recipientId":null,"sortOrder":1}]},"key":"RadioButton","summary":"RadioButton","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/RadioButton"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown":{"value":{"tasks":[{"field":{"fieldType":"DropDown","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"readOnly":false,"required":false,"positionX":50,"positionY":400,"width":150,"height":30,"page":1,"id":"dd1"},"recipientId":null,"sortOrder":1}]},"key":"DropDown","summary":"DropDown","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/DropDown"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox":{"value":{"tasks":[{"field":{"fieldType":"ListBox","font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"options":[{"key":"val1","value":"Label 1","selected":false},{"key":"val2","value":"Label 2","selected":true}],"multiselect":true,"readOnly":false,"required":false,"positionX":50,"positionY":500,"width":150,"height":80,"page":1,"id":"lb1"},"recipientId":null,"sortOrder":1}]},"key":"ListBox","summary":"ListBox","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/ListBox"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment":{"value":{"tasks":[{"field":{"fieldType":"Attachment","required":false,"positionX":50,"positionY":600,"width":100,"height":30,"page":1,"id":"att1"},"recipientId":null,"sortOrder":1}]},"key":"Attachment","summary":"Attachment","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Attachment"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Text","value":"Default text"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Text","summary":"Annotation - Text","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Text"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Date","format":"dd.MM.yyyy"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Date","summary":"Annotation - Date","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Date"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FullName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - FullName","summary":"Annotation - FullName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FullName"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"FirstName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - FirstName","summary":"Annotation - FirstName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - FirstName"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"LastName"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - LastName","summary":"Annotation - LastName","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - LastName"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Initials"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Initials","summary":"Annotation - Initials","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Initials"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email":{"value":{"tasks":[{"field":{"fieldType":"Annotation","annotationConfig":{"annotationType":"Email"},"font":{"size":12,"name":"Arial","color":"#000000","align":"Left","italic":false,"bold":false},"elementName":"AnnotationField_1","positionX":100,"positionY":200,"width":200,"height":30,"page":1,"id":"ann1"},"recipientId":null,"sortOrder":1}]},"key":"Annotation - Email","summary":"Annotation - Email","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Annotation - Email"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link":{"value":{"tasks":[{"field":{"fieldType":"Link","reference":"https://example.com","positionX":50,"positionY":700,"width":150,"height":30,"page":1,"id":"lnk1"},"recipientId":null,"sortOrder":1}]},"key":"Link","summary":"Link","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Link"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"FileReadConfirmation","required":false,"id":"frc1"},"recipientId":null,"sortOrder":1}]},"key":"FileReadConfirmation","summary":"FileReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/FileReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"PageReadConfirmation","required":false,"page":1,"id":"prc1"},"recipientId":null,"sortOrder":1}]},"key":"PageReadConfirmation","summary":"PageReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/PageReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation":{"value":{"tasks":[{"field":{"fieldType":"AreaReadConfirmation","required":false,"positionX":50,"positionY":250,"width":200,"height":100,"page":1,"id":"arc1"},"recipientId":null,"sortOrder":1}]},"key":"AreaReadConfirmation","summary":"AreaReadConfirmation","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/AreaReadConfirmation"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval":{"value":{"tasks":[{"field":{"fieldType":"Approval","required":false,"layoutId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","positionX":100,"positionY":200,"width":200,"height":50,"page":1,"id":"app1"},"recipientId":null,"sortOrder":1}]},"key":"Approval","summary":"Approval","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1files~1{fileId}~1tasks/put/requestBody/content/application~1json/examples/Approval"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer":{"value":{"type":"Signer","name":"Signer Stage","requiredRecipientCompletions":1},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"type":"CarbonCopy","name":"CarbonCopy Stage"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer":{"value":{"type":"Viewer","name":"Viewer Stage","requiredRecipientCompletions":1},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","name":"Automatic Stage"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver":{"value":{"type":"Approver","name":"Approver Stage","requiredRecipientCompletions":1},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example":{"value":{"stages":[{"id":"00000000-0000-0000-0000-000000000001","sortOrder":1},{"id":"00000000-0000-0000-0000-000000000002","sortOrder":2}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000010","name":"Stage 1","sortOrder":1,"requiredRecipientCompletions":1,"type":"Signer","recipients":[{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"id":"00000000-0000-0000-0000-000000000100"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer":{"value":{"name":"Signer Stage","requiredRecipientCompletions":1,"type":"Signer"},"key":"Signer","summary":"Signer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Signer"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy":{"value":{"name":"CarbonCopy Stage","requiredRecipientCompletions":1,"type":"CarbonCopy"},"key":"CarbonCopy","summary":"CarbonCopy","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/CarbonCopy"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer":{"value":{"name":"Viewer Stage","requiredRecipientCompletions":1,"type":"Viewer"},"key":"Viewer","summary":"Viewer","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Viewer"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"name":"Automatic Stage","requiredRecipientCompletions":1,"type":"Automatic"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver":{"value":{"name":"Approver Stage","requiredRecipientCompletions":1,"type":"Approver"},"key":"Approver","summary":"Approver","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}/put/requestBody/content/application~1json/examples/Approver"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example":{"value":{"id":"00000000-0000-0000-0000-000000000100"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic":{"value":{"type":"Automatic","signatureProfile":"default-eseal-profile","signatureReason":"I agree to the terms.","languageCode":"en"},"key":"Automatic","summary":"Automatic","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Automatic"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - No authentication","summary":"Standard - No authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - No authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oneTimePassword":{"channel":"Sms"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OTP SMS","summary":"Standard - OTP SMS","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OTP SMS"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"accessCode":{"code":"1234"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Access code","summary":"Standard - Access code","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Access code"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"authentication":{"oAuthAuthentications":[{"providerName":"google","id":"3f2504e0-4f89-41d3-9a0c-0305e82c3301"}]},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - OAuth","summary":"Standard - OAuth","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - OAuth"},"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate":{"value":{"type":"Standard","givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","phoneNumber":"+39123456789","notificationChannels":["Email"],"signatureConfiguration":{"disposableCertificate":{"document":{"type":"IdentityCard","number":"AA1234567","serialNumber":"SN-0001","issuingCountry":"IT","issuedBy":"Comune di Roma","issuedOn":"2020-01-15T00:00:00+00:00","expiresAt":"2030-01-15T00:00:00+00:00"},"identification":{"type":"NationalIdentityCard","issuingCountry":"IT"},"verificationPhoneNumber":"+39123456789"}},"personalMessage":"Please review and sign the attached document.","signatureReason":"I agree to the terms.","isSignatureReasonEditable":false,"languageCode":"en"},"key":"Standard - Disposable certificate","summary":"Standard - Disposable certificate","id":"paths/~1api~1v1~1organizations~1{organizationId}~1templates~1{templateId}~1stages~1{stageId}~1recipients~1{recipientId}/put/requestBody/content/application~1json/examples/Standard - Disposable certificate"},"paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example":{"value":{"givenName":"Mario","surname":"Rossi","email":"mario.rossi@example.com","regionalSettings":{"timeZone":"Europe/Berlin","dateTimeFormat":"dd/MM/yyyy | HH:mm","language":"it","country":"IT"},"phoneNumber":"+39021234567"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1users/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example":{"value":{"givenName":"Mario","surname":"Rossi","regionalSettings":{"timeZone":"Europe/Berlin","dateTimeFormat":"dd/MM/yyyy | HH:mm","language":"it","country":"IT"},"phoneNumber":"+39021234567"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example":{"value":{"applicationRoles":[{"id":"550e8400-e29b-41d4-a716-446655440000"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1users~1{userId}~1application-roles/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example":{"value":{"userGroups":[{"id":"92b18930-7fef-43c9-8c32-39e4adb112e7","name":"Sales Team"},{"id":"2546d916-ae17-40fc-8c36-5eec748bd923","name":"Legal Team"}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example":{"value":{"name":"Sales Team"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example":{"value":{"id":"99d90989-2e22-40a3-ad81-bfb8636ee01b"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example":{"value":{"name":"Sales Team"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example":{"value":{"customFields":[{"id":"400658ab-5f75-43c3-aff1-1ca6a046d9fa","name":"Tax code"},{"id":"512a272d-515b-4413-a8e0-4805e795da50","name":"Department"}]},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example":{"value":{"users":[{"id":"c2d3e4f5-a6b7-48c9-b0c1-d2e3f4a5b6c7","email":"alice@example.com","givenName":"Alice","surname":"Johnson"},{"id":"d4e5f6a7-b8c9-4a0b-c1d2-e3f4a5b6c7d8","email":"bob@example.com","givenName":"Bob","surname":"Smith"}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example":{"value":{"userId":"c2d3e4f5-a6b7-48c9-b0c1-d2e3f4a5b6c7","permissions":{"users":{"read":true,"createUpdateDelete":false},"envelopes":{"share":true,"manage":false},"templates":{"share":true,"manage":false},"contacts":{"read":true,"createUpdateDelete":false,"customize":false}},"businessRoleId":"43f3e4f5-a6b7-48c9-b0c1-d2e3f4a5b6c7"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example":{"value":{"id":"a7b8c9d0-e1f2-4a5b-8c6d-7e8f9a0b1c2d","permissions":{"users":{"read":true,"createUpdateDelete":false},"envelopes":{"share":true,"manage":false},"templates":{"share":true,"manage":false},"contacts":{"read":true,"createUpdateDelete":false,"customize":false}},"businessRoleId":"f3a4b5c6-d7e8-49f0-a1b2-c3d4e5f6a7b8"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example":{"value":{"permissions":{"users":{"read":true,"createUpdateDelete":false},"envelopes":{"share":true,"manage":false},"templates":{"share":true,"manage":false},"contacts":{"read":true,"createUpdateDelete":false,"customize":false}},"businessRoleId":"c2d3e4f5-a6b7-48c9-b0c1-d2e3f4a5b6c7"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1users~1{userId}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example":{"value":{"contacts":[{"id":"e201ace1-7752-4a33-a9b3-2a46902e8de3","email":"john.smith@example.com","givenName":"John","surname":"Smith","phoneNumber":"+44 20 7946 0958","language":"en","Tax code":"AB123456C","Department":"Administration"},{"id":"34729a5f-71b6-4206-aa8f-eb2ef9c06257","email":"emily.clarke@example.com","givenName":"Emily","surname":"Clarke","phoneNumber":"+44 161 496 0123","language":"en","Tax code":"CD987654A","Department":"Purchasing"}],"pagination":{"page":1,"pageSize":10,"totalCount":2}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only":{"value":{"givenName":"John","surname":"Smith","email":"john.smith@example.com","phoneNumber":"+44 20 7946 0958","language":"en"},"key":"standard fields only","summary":"standard fields only","id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/standard fields only"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields":{"value":{"givenName":"John","surname":"Smith","email":"john.smith@example.com","phoneNumber":"+44 20 7946 0958","language":"en","Tax code":"AB123456C","Department":"Administration"},"key":"with custom fields","summary":"with custom fields","id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/requestBody/content/application~1json/examples/with custom fields"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example":{"value":{"id":"e201ace1-7752-4a33-a9b3-2a46902e8de3"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example":{"value":{"id":"e201ace1-7752-4a33-a9b3-2a46902e8de3","email":"john.smith@example.com","givenName":"John","surname":"Smith","phoneNumber":"+44 20 7946 0958","language":"en","Tax code":"AB123456C","Department":"Administration"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only":{"value":{"givenName":"John","surname":"Smith","email":"john.smith@example.com","phoneNumber":"+44 20 7946 0958","language":"en"},"key":"standard fields only","summary":"standard fields only","id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/standard fields only"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields":{"value":{"givenName":"John","surname":"Smith","email":"john.smith@example.com","phoneNumber":"+44 20 7946 0958","language":"en","Tax code":"AB123456C","Department":"Administration"},"key":"with custom fields","summary":"with custom fields","id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contacts~1{contactId}/put/requestBody/content/application~1json/examples/with custom fields"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example":{"value":{"id":"400658ab-5f75-43c3-aff1-1ca6a046d9fa","name":"Tax code"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example":{"value":{"name":"Tax code"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1user-groups~1{userGroupId}~1contact-custom-fields~1{fieldId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication":{"value":{"url":"https://example.com/hooks/envelope","event":"EnvelopeCompleted"},"key":"without authentication","summary":"without authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication":{"value":{"url":"https://example.com/hooks/envelope","event":"EnvelopeCompleted","authentication":{"headers":{"Authorization":"Bearer token_123"}}},"key":"with header authentication","summary":"with header authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example":{"value":{"id":"b1f2c3d4-e5f6-7890-abcd-ef1234567890","url":"https://example.com/hooks/envelope","event":"EnvelopeCompleted","createdAt":"2026-10-05T10:30:00+00:00","updatedAt":"2026-10-05T10:30:00+00:00","authentication":{"headers":{"Authorization":"*****"},"clientCertificate":null,"clientKey":null}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example":{"value":{"url":"https://example.com/hooks/envelope-new","event":"EnvelopeCompleted","authentication":{"headers":{"Authorization":"Bearer token_123"}}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication":{"value":{"url":"https://example.com/hooks/organization","event":"EnvelopeCompleted"},"key":"without authentication","summary":"without authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/without authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication":{"value":{"url":"https://example.com/hooks/organization","event":"EnvelopeCompleted","authentication":{"headers":{"Authorization":"Bearer token_123"}}},"key":"with header authentication","summary":"with header authentication","id":"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks/post/requestBody/content/application~1json/examples/with header authentication"},"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example":{"value":{"id":"c2a3b4d5-e6f7-4890-abcd-ef1234567890","url":"https://example.com/hooks/organization","event":"EnvelopeCompleted","createdAt":"2026-10-05T10:30:00+00:00","updatedAt":"2026-10-05T10:30:00+00:00","authentication":{"headers":{"Authorization":"*****"},"clientCertificate":null,"clientKey":null}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example":{"value":{"url":"https://example.com/hooks/organization-new","event":"EnvelopeCompleted","authentication":{"headers":{"Authorization":"Bearer token_123"}}},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example":{"value":{"id":"11111111-1111-1111-1111-111111111111","url":"https://hook.example.com","hasHeaders":false,"hasClientCertificate":false,"createdAt":"2026-11-11T14:00:03.4952172+00:00"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example":{"value":{"url":"https://hook.example.com"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example":{"value":{"id":"11111111-1111-1111-1111-111111111111","url":"https://hook.example.com","hasHeaders":false,"hasClientCertificate":false,"createdAt":"2026-11-11T14:00:03.4970766+00:00"},"id":"paths/~1api~1v1~1organizations~1{organizationId}~1envelopes~1{envelopeId}~1webhook-subscription/post/responses/201/content/application~1json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Insert your JWT Bearer token from MyNamirial"},"PersonalAccessToken":{"id":"PersonalAccessToken","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'."},"children":[]}]}]}],"in":"header","paramName":"Personal-Access-Token"}},"specVersion":"3.0.4","specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/namirialsignenterprise/openapi3.json?download"},{"url":"/_bundle/products/namirialsignenterprise/openapi3.yaml?download"}],"excludeFromSearch":false,"rbac":{"redocly-team-mantainers":"write","redocly-team-namirialsignenterprise-integrators":"read","anonymous":"read","authenticated":"read"},"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Namirial Sign Enterprise API","description":"Namirial Sign Enterprise API"}},"baseSlug":"/products/namirialsignenterprise/openapi3","routesMapping":{}}