openapi: 3.0.3 info: title: Docupilot V2 APIs version: '3.0' description: Docupilot V2 APIs termsOfService: https://docupilot.app/terms-and-conditions/ contact: name: Team Docupilot email: support@docupilot.app paths: /dashboard/accounts/v2/auth_tokens/: get: operationId: list_auth_tokens parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - auth_tokens security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthToken' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_auth_token parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - auth_tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthToken' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthToken' multipart/form-data: schema: $ref: '#/components/schemas/AuthToken' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/NewAuthTokenResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/auth_tokens/{id}/: put: operationId: update_auth_token parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this auth token. required: true tags: - auth_tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthToken' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthToken' multipart/form-data: schema: $ref: '#/components/schemas/AuthToken' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthToken' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_auth_token parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this auth token. required: true tags: - auth_tokens security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/invitations/: get: operationId: list_invitation summary: Get list of Invitation parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: is_accepted schema: type: boolean - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - invitations security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Invitation' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_invitation summary: Create Invitation parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/Invitation' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Invitation' multipart/form-data: schema: $ref: '#/components/schemas/Invitation' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Invitation' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/invitations/{id}/: delete: operationId: delete_invitation summary: Delete Invitation parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this invitation. required: true tags: - invitations security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/invitations/{id}/resend_invitation/: post: operationId: resend_invitation summary: Resend invitation parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this invitation. required: true tags: - invitations security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invitation' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/organization/current/: get: operationId: get_current_organization summary: get current organization details tags: - organization security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/addon_pricing_info/: get: operationId: addon_pricing_info parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AddonPricingInfo' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/buy_addon/: post: operationId: purchase_addon parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription requestBody: content: application/json: schema: $ref: '#/components/schemas/AddonPurchase' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddonPurchase' multipart/form-data: schema: $ref: '#/components/schemas/AddonPurchase' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/details/: get: operationId: get_subscription_details parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChargebeeSubscription' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/extend_trial/: post: operationId: extend_trial summary: Extend trial parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/hosted_page/: get: operationId: get_chargebee_hosted_page parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: plan_id schema: type: string tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/portal_session/: get: operationId: get_chargebee_portal_session parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChargebeeSubscription' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/remaining_months/: get: operationId: get_subscription_remaining_months parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/renew_request/: post: operationId: subscription_renew_request_create parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription requestBody: content: application/json: schema: $ref: '#/components/schemas/RenewSubscription' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RenewSubscription' multipart/form-data: schema: $ref: '#/components/schemas/RenewSubscription' security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/resume/: post: operationId: resume_subscription parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/subscription/unpaid_invoices/: get: operationId: get_chargebee_unpaid_invoices parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - subscription security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HostedPage' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/team/: get: operationId: list_all_team_members summary: List all team members parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: role schema: type: string enum: - admin - billing_manager - manager - member - owner tags: - team security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamMember' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/team/{id}/change_role/: put: operationId: change_role_of_team_member summary: Change role of team member. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true tags: - team requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRole' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ChangeRole' multipart/form-data: schema: $ref: '#/components/schemas/ChangeRole' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TeamMember' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/team/{id}/toggle_user_status/: patch: operationId: toggle_user_status summary: Activate or Deactivate a User parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - team security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TeamMember' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/template_gallery/: get: operationId: list_gallery_templates summary: Get list of galery templates parameters: - in: query name: category schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - Gallery templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateGallery' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/template_gallery/{id}/: get: operationId: get_gallery_template summary: Get one template parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this template gallery. required: true tags: - Gallery templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateGallery' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/g2_review/: get: operationId: g2_review summary: Redirect to G2 Review Page tags: - user_satisfaction_survey security: - SessionAuthentication: [] responses: '302': description: No response body '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/nps_next_reminder/: post: operationId: nps_next_reminder summary: Update the next NPS reminder time tags: - user_satisfaction_survey requestBody: content: application/json: schema: $ref: '#/components/schemas/NpsNextReminder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/NpsNextReminder' multipart/form-data: schema: $ref: '#/components/schemas/NpsNextReminder' required: true security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/nps_rating/: post: operationId: nps_rating summary: Update NPS rating tags: - user_satisfaction_survey requestBody: content: application/json: schema: $ref: '#/components/schemas/NpsRating' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/NpsRating' multipart/form-data: schema: $ref: '#/components/schemas/NpsRating' security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/save_user_feedback/: post: operationId: save_customer_feedback summary: Save customer feedback tags: - user_satisfaction_survey requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveCustomerFeedback' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SaveCustomerFeedback' multipart/form-data: schema: $ref: '#/components/schemas/SaveCustomerFeedback' required: true security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/show_survey_prompt/: get: operationId: show_survey_prompt summary: Show survey prompt parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - user_satisfaction_survey security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SurveyPrompt' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/user_satisfaction_survey/update_g2_review_updated_on/: post: operationId: update_g2_review_updated_on summary: Update g2_review_updated_on tags: - user_satisfaction_survey security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/users/exchange_session/: get: operationId: get_exchange_session_code description: Generates a short-lived UUID code linked to the current session key for cross-domain migration. summary: Exchange session for a migration code tags: - users security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExchangeSessionResponse' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/users/initiate_authorization_sequence/: post: operationId: initiate_authorization_sequence summary: Initiate a re-authorization sequence that would verify authenticity of logged-in userin order to allow performing high security operations like delete workspace tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateAuthorizationSequence' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InitiateAuthorizationSequence' multipart/form-data: schema: $ref: '#/components/schemas/InitiateAuthorizationSequence' security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' /dashboard/accounts/v2/users/me/: get: operationId: get_me summary: get logged in user details tags: - users security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' /dashboard/accounts/v2/users/migrate_session/: get: operationId: attach_session_from_exchange_code description: Endpoint called on the API domain to exchange a short-lived code for a session cookie. summary: Migrate session to API domain parameters: - in: query name: org schema: type: string description: The organization subdomain (e.g., 'rush') required: true - in: query name: session_exchange_code schema: type: string description: The one-time UUID exchange code obtained from /exchange_session/ required: true tags: - users responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrateSessionResponse' description: '' /dashboard/accounts/v2/users/update_user_profile/: patch: operationId: update_user_profile summary: Update User Profile tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateUser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateUser' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateUser' security: - SessionAuthentication: [] responses: '202': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/workspaces/: get: operationId: list_workspaces summary: Get list of Workspaces parameters: - in: query name: active schema: type: boolean - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - workspaces security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Workspace' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_workspace summary: Create Workspace tags: - workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/Workspace' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Workspace' multipart/form-data: schema: $ref: '#/components/schemas/Workspace' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Workspace' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/workspaces/current/: get: operationId: get_current_workspace summary: get current workspace details parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - workspaces security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Workspace' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' patch: operationId: update_current_workspace summary: update current workspace details parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWorkspace' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedWorkspace' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWorkspace' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatchedWorkspace' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/workspaces/current/delete/: post: operationId: delete_current_workspace summary: Delete a workspace and other related data permanently parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteCurrentWorkspace' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeleteCurrentWorkspace' multipart/form-data: schema: $ref: '#/components/schemas/DeleteCurrentWorkspace' required: true security: - SessionAuthentication: [] responses: '200': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/accounts/v2/workspaces/retention_preference/: get: operationId: get_workspace_data_retention_preference summary: get workspace data retention preference parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - workspaces security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetentionPreference' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' put: operationId: update_workspace_data_retention_preference summary: update workspace data retention preference parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/RetentionPreference' examples: Example1: value: merge_data: P1D generated_document: P1D summary: Retention Example 1 Day Example2: value: merge_data: P1M0DT0H generated_document: P1M0DT0H summary: Retention Example 1 Month application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetentionPreference' multipart/form-data: schema: $ref: '#/components/schemas/RetentionPreference' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetentionPreference' examples: Example1: value: merge_data: P1D generated_document: P1D summary: Retention Example 1 Day Example2: value: merge_data: P1M0DT0H generated_document: P1M0DT0H summary: Retention Example 1 Month description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/ai/online-builder/create_template/: post: operationId: create_template_online_builder_ai summary: create template using ai parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - ai requestBody: content: application/json: schema: $ref: '#/components/schemas/AITemplateCreate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AITemplateCreate' multipart/form-data: schema: $ref: '#/components/schemas/AITemplateCreate' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AITemplateCreate' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/ai/online-builder/edit_template/: post: operationId: edit_template_online_builder_ai summary: edit template using chat completion parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - ai requestBody: content: application/json: schema: $ref: '#/components/schemas/AITemplateEdit' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AITemplateEdit' multipart/form-data: schema: $ref: '#/components/schemas/AITemplateEdit' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AITemplateEdit' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/ai/online-builder/list_prompt_suggestions/: post: operationId: prompt_suggestions_online_builder_ai summary: list prompt suggestions based on template name and description parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - ai requestBody: content: application/json: schema: $ref: '#/components/schemas/PromptSuggestions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PromptSuggestions' multipart/form-data: schema: $ref: '#/components/schemas/PromptSuggestions' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PromptSuggestions' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/ai/word-add-in/edit_template/: post: operationId: edit_word_template_using_ai summary: Edit word template using ai parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - ai requestBody: content: application/json: schema: $ref: '#/components/schemas/WordAddInTemplateEdit' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WordAddInTemplateEdit' multipart/form-data: schema: $ref: '#/components/schemas/WordAddInTemplateEdit' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WordAddInTemplateEdit' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/ai/word-add-in/list_prompt_suggestions/: post: operationId: prompt_suggestions_word_add_in_ai summary: list prompt suggestions based on File Name and Content parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - ai requestBody: content: application/json: schema: $ref: '#/components/schemas/WordAddInPromptSuggestions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WordAddInPromptSuggestions' multipart/form-data: schema: $ref: '#/components/schemas/WordAddInPromptSuggestions' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WordAddInPromptSuggestions' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/append/: post: operationId: append_files parameters: - in: header name: X-Client schema: type: string description: Client Origin - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - append requestBody: content: application/json: schema: $ref: '#/components/schemas/AppendFiles' multipart/form-data: schema: $ref: '#/components/schemas/AppendFiles' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: object properties: file_url: type: string file_name: type: string application/pdf: schema: type: string format: binary description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' application/pdf: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' application/pdf: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' application/pdf: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/content_blocks/: get: operationId: list_content_blocks summary: Get list of content blocks parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedContentBlockList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_content_block summary: Create content_block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - content_blocks requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/NewContentBlock' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/content_blocks/{content_block_id}/permissions/: get: operationId: list_content_block_sharing summary: Get all shared permissions for specific content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: content_block_id schema: type: integer required: true tags: - content_blocks security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ContentBlockSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_content_block_sharing_permission summary: Create content block sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: content_block_id schema: type: integer required: true tags: - content_blocks requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ContentBlockSharing' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/ContentBlockSharing' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ContentBlockSharing' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/ContentBlockSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{content_block_id}/permissions/{id}/: get: operationId: get_content_block_sharing summary: Get specific permission details for given content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: content_block_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block sharing setting. required: true tags: - content_blocks security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlockSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_content_block_sharing_permission summary: Update content block content partially parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: content_block_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block sharing setting. required: true tags: - content_blocks requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateContentBlockSharing' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateContentBlockSharing' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateContentBlockSharing' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlockSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: revoke_content_block_sharing_permission summary: Revoke content block sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: content_block_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block sharing setting. required: true tags: - content_blocks security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/: get: operationId: get_content_block summary: Get one content_block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' put: operationId: update_content_block summary: Update content_block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: application/json: schema: $ref: '#/components/schemas/ContentBlock' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ContentBlock' multipart/form-data: schema: $ref: '#/components/schemas/ContentBlock' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_content_block_data summary: Update content block data parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateNewContentBlock' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_content_block summary: Delete a content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/copy/: post: operationId: copy_content_block summary: Copy content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyContentBlock' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CopyContentBlock' multipart/form-data: schema: $ref: '#/components/schemas/CopyContentBlock' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/download/: get: operationId: download_content_block_file summary: Download content block file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: text/html: schema: type: string format: binary application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary application/vnd.openxmlformats-officedocument.wordprocessingml.document: schema: type: string format: binary application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/editor_version/: patch: operationId: update_content_block_editor_version summary: Update the content block editor version between v1 and v2 parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedContentBlockEditorVersion' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedContentBlockEditorVersion' multipart/form-data: schema: $ref: '#/components/schemas/PatchedContentBlockEditorVersion' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlockEditorVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/inline_image/: post: operationId: upload_inline_image_of_content_block summary: Upload inline image of content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/UploadContentBlockImage' required: true security: - SessionAuthentication: [] responses: '200': description: No response body '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/preview/: get: operationId: preview_content_block_file summary: Preview content block file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: format schema: type: string enum: - json - octet-stream - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks security: - SessionAuthentication: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/schema/: get: operationId: get_content_block_schema summary: Get content block schema parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateSchema' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/content_blocks/{id}/templates/: get: operationId: list_content_block_templates summary: List content block templates parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTemplateInfoList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/content_blocks/{id}/test/: post: operationId: test_content_block summary: Test a content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks requestBody: content: application/json: schema: type: object additionalProperties: {} security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TestContentBlock' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/{id}/test_data/: get: operationId: get_test_data_for_content_block summary: Get test data used for testing content block parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this content block. required: true tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlock' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/content_blocks/detail/by-key/: get: operationId: fetch_content_block_detail_by_key summary: Get content block detail by API name (key) parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: key schema: type: string description: API name (key) of the content block required: true tags: - content_blocks security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContentBlockDetailByKeyResponse' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/convert/: post: operationId: convert-files parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: response_type schema: type: string enum: - stream - url description: If stream, returns the converted file as a downloadable binary (PDF / PNG / ZIP). If url, returns JSON with file_url and file_name. - in: query name: test schema: type: boolean description: If true, the document will be generated in test mode (with watermark and without deducting merge credits). tags: - convert requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertJsonRequest' multipart/form-data: schema: $ref: '#/components/schemas/ConvertMultipartRequest' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: object properties: file_url: type: string file_name: type: string description: Returned when download=false application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary application/zip: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/domain/{id}/: get: operationId: get_domain summary: Get one domain parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this domain. required: true tags: - domain security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Domain' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/domain/{id}/verify/: patch: operationId: verify_domain summary: verify domain parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this domain. required: true tags: - domain requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDomain' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDomain' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDomain' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DomainVerify' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/folders/: get: operationId: list_folders summary: Get list of folders parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: permission schema: type: string enum: - manage - read - write tags: - folders security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Folder' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_folder summary: Create a folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - folders requestBody: content: application/json: schema: $ref: '#/components/schemas/Folder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Folder' multipart/form-data: schema: $ref: '#/components/schemas/Folder' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Folder' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/folders/{folder_id}/permissions/: get: operationId: list_folder_sharing summary: Get all shared permissions for specific folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true tags: - folders security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FolderSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_folder_sharing_permission summary: Create folder sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true tags: - folders requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FolderSharing' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/FolderSharing' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FolderSharing' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/FolderSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/folders/{folder_id}/permissions/{id}/: get: operationId: get_folder_sharing summary: Get specific permission details for given folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this folder sharing setting. required: true tags: - folders security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_folder_sharing_permission_content summary: Update folder content partially parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this folder sharing setting. required: true tags: - folders requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateFolderSharing' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateFolderSharing' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateFolderSharing' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: revoke_folder_sharing_permission summary: Revoke folder sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this folder sharing setting. required: true tags: - folders security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/folders/{id}/: put: operationId: update_folder summary: Updates a folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this folder. required: true tags: - folders requestBody: content: application/json: schema: $ref: '#/components/schemas/Folder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Folder' multipart/form-data: schema: $ref: '#/components/schemas/Folder' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Folder' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_folder description: This operation moves all templates under this folder to home directory. summary: Delete a folder. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this folder. required: true tags: - folders security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/folders/count/: get: operationId: get_user_created_folder_count summary: Get the count of folders created by the user. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: owner_id schema: type: string description: Owner Id of resource required: true tags: - folders security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderCount' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/folders/sharing_status/: get: operationId: folders_sharing_status_retrieve parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - folders security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingInfoFolder' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/history/: get: operationId: get_created_documents_history summary: Get created documents history parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: end_date schema: type: string format: date-time description: 'DateTime in this format: 2019-05-02 16:25:12.353000' - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: start_date schema: type: string format: date-time description: 'DateTime in this format: 2019-05-02 16:25:12.353000' - in: query name: status schema: type: string enum: - error - pending - success - in: query name: template schema: type: integer tags: - history security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMergeHistoryList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/history/{id}/download/: get: operationId: download_created_document summary: download generated document if available parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this merge history. required: true tags: - history security: - SessionAuthentication: [] responses: '200': content: text/html: schema: type: string format: binary application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary application/vnd.openxmlformats-officedocument.wordprocessingml.document: schema: type: string format: binary application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/history/{id}/retry_delivery/: post: operationId: retry_delivery summary: retry failed documents delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this merge history. required: true tags: - history requestBody: content: application/json: schema: $ref: '#/components/schemas/MergeHistory' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MergeHistory' multipart/form-data: schema: $ref: '#/components/schemas/MergeHistory' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MergeHistory' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/history/export/: get: operationId: get_created_export_merge_history summary: Get created export history parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - history security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportMergeHistory' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_export_history_task summary: Create export history task parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - history requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportMergeHistory' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportMergeHistory' multipart/form-data: schema: $ref: '#/components/schemas/ExportMergeHistory' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ExportMergeHistory' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/history/export/{id}/download/: get: operationId: download_created_export_document summary: download generated export document if available parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this export merge history task. required: true tags: - history security: - SessionAuthentication: [] responses: '200': content: text/html: schema: type: string format: binary application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary application/vnd.openxmlformats-officedocument.wordprocessingml.document: schema: type: string format: binary application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/: get: operationId: list_delivery_accounts summary: Get list of linked accounts parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string enum: - aws_s3 - azure_storage - box - docu_sign - dropbox - email - eversign - google_drive - hellosign - one_drive - podio - sftp - sharepoint - sign_now - signable - yousign - zoho - zoho_crm tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeliveryAccount' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: add_delivery_account summary: Create linked account parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - linked_accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/DeliveryAccount' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeliveryAccount' multipart/form-data: schema: $ref: '#/components/schemas/DeliveryAccount' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeliveryAccount' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/linked_accounts/{integrator_type}/invoke/: get: operationId: invoke_integrator description: Redirects to oauth endpoint to add a new linked account of given 'integrator_type' parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: environment schema: type: string description: 'sub-type of integrator. For example: sandbox or production for docu_sign' - in: path name: integrator_type schema: type: string enum: - box - docu_sign - dropbox - eversign - google_drive - one_drive - podio - sharepoint - sign_now - zoho description: Type of integrator required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '302': description: No response body '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/: put: operationId: update_delivery_account summary: Refresh linked account parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeliveryAccount' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDeliveryAccount' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDeliveryAccount' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeliveryAccount' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: revoke_delivery_account summary: Revoke linked account parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/box_drive_picker_payload/: get: operationId: get_box_drive_picker_payload description: Get box drive picker payload parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BoxDrivePickerPayload' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/deliveries/: get: operationId: list_account_deliveries description: List account deliveries parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: type schema: type: string enum: - aws_s3 - azure_storage - box - docu_sign - dropbox - email - eversign - google_drive - hellosign - one_drive - podio - sftp - sharepoint - sign_now - signable - yousign - zoho - zoho_crm tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountDeliveryList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/linked_accounts/{id}/delivery_emails/: get: operationId: list_delivery_emails_for_email_account description: List delivery emails for email account parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: type: string examples: ResponseExample: value: - abc@gmail.com - abcd@gmail.com summary: Response Example description: An array of emails '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/docusign_folders/: get: operationId: get_docusign_folders description: Get docusign folders parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DocuSignFolder' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/google_picker_payload/: get: operationId: get_google_picker_payload description: Get google picker payload parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleDrivePickerPayload' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/initiate_authorization/: post: operationId: initiate_email_authorization description: Initiate email authorization parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP' multipart/form-data: schema: $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP' required: true security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/reconnect/: get: operationId: reconnect_account description: Redirects to oauth endpoint for re-connecting an account parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '302': description: No response body '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/sharepoint_picker_payload/: get: operationId: get_sharepoint_picker_payload description: Get sharepoint picker payload parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharepointPickerPayload' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/toggle_use_for_images/: post: operationId: update_delivery_accounts_use_for_images_flag description: Update delivery accounts use for images flag parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeliveryAccount' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/{id}/verify_otp/: put: operationId: verify_email_otp description: Verify email otp parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery account. required: true tags: - linked_accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyEmailAccountOTP' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VerifyEmailAccountOTP' multipart/form-data: schema: $ref: '#/components/schemas/VerifyEmailAccountOTP' required: true security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/linked_accounts/send_test_mail/: post: operationId: Send test mail description: send_test_mail parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - linked_accounts requestBody: content: application/json: schema: $ref: '#/components/schemas/SendTestSmtpMail' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendTestSmtpMail' multipart/form-data: schema: $ref: '#/components/schemas/SendTestSmtpMail' required: true security: - SessionAuthentication: [] responses: '200': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/merge_history/: get: operationId: get_created_documents_merge_history summary: Get created documents merge history parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: end_date schema: type: string format: date-time - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string description: Search across created_file_name field - in: query name: start_date schema: type: string format: date-time - in: query name: status schema: type: string enum: - error - pending - success - in: query name: template schema: type: integer tags: - merge_history security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDocumentMergeHistoryList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/merge_history/{id}/download/: get: operationId: download_created_document_using_document_merge_history summary: download generated document if available parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document merge history. required: true tags: - merge_history security: - SessionAuthentication: [] responses: '200': content: text/html: schema: type: string format: binary application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary application/vnd.openxmlformats-officedocument.wordprocessingml.document: schema: type: string format: binary application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/pdf/transform/: post: operationId: pdf_transform parameters: - in: header name: X-Client schema: type: string description: Client Origin - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: response_type schema: type: string enum: - stream - url description: If stream, returns the transformed file as a downloadable PDF. If url, returns JSON with file_url and file_name. - in: query name: test schema: type: boolean description: If true, the document will be generated in test mode (with watermark and without deducting merge credits). tags: - pdf requestBody: content: application/json: schema: $ref: '#/components/schemas/PDFTransformJsonRequest' examples: JSONTransformExample: value: inputs: - id: pdf1 file_url: https://example.com/input-1.pdf - id: pdf2 file_url: https://example.com/input-2.pdf operations: - id: build-base type: compose sources: - input: pdf1 pages: 1-3 - input: pdf2 pages: all - id: rotate-pages type: rotate target: current pages: 1-2 angle: 90 - id: add-page-numbers type: page_number target: current pages: all format: Page {n} of {total} position: bottom-center output_file_name: processed.pdf summary: Compose + rotate + page numbers multipart/form-data: schema: $ref: '#/components/schemas/PDFTransformMultipartRequest' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: object properties: file_url: type: string file_name: type: string application/pdf: schema: type: string format: binary description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/permissions/content_block/: get: operationId: get_content_block_permissions description: Returns content_block permissions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: ids schema: type: string tags: - permissions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: array items: type: string enum: - read - write - manage example: '199': - read - write '1201': - read '90': - write examples: ResponseExample: value: '199': - manage - read - write '1201': - read '90': - write - read summary: Response Example description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/permissions/folder/: get: operationId: get_folder_permissions description: Returns folder permissions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: ids schema: type: string tags: - permissions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: array items: type: string enum: - read - write - manage example: '199': - read - write '1201': - read '90': - write description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/permissions/global/: get: operationId: get_global_permissions description: Returns permission for each role parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - permissions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GlobalPermission' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/permissions/template/: get: operationId: get_template_permissions description: Returns template permissions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: ids schema: type: string tags: - permissions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: array items: type: string enum: - read - write - manage example: '199': - read - write '1201': - read '90': - write description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/personalization/: get: operationId: get_user_personalization parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - personalization security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UserPersonalization' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: update_user_personalization parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - personalization requestBody: content: application/json: schema: $ref: '#/components/schemas/UserPersonalization' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserPersonalization' multipart/form-data: schema: $ref: '#/components/schemas/UserPersonalization' security: - SessionAuthentication: [] responses: '201': content: application/json: schema: type: object additionalProperties: {} description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' /dashboard/api/v2/templates/: get: operationId: list_templates summary: Get list of templates parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: delivery_type schema: type: array items: type: string enum: - aws_s3 - azure_blob_storage - box_drive - docu_sign - dropbox - email - eversign - google_drive - hellosign - one_drive - podio - sftp - sharepoint - sign_now - signable - signature - webhook - yousign - zoho_crm description: Filter templates by configured delivery type (supports multiple values) explode: false style: form - in: query name: folder schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: output_type schema: type: string enum: - docx - html - jpeg - pdf - png - pptx - xlsx - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string description: Search templates by title - in: query name: status schema: type: string enum: - active - test description: Filter templates by status. Active maps to published templates and test maps to unpublished templates. - in: query name: type schema: type: string enum: - docx - dpt_pdf - fillable_pdf - g_document - g_presentation - g_spreadsheet - html - pptx - xlsx tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTemplateList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_template summary: Create template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - templates requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/NewTemplate' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/{id}/: get: operationId: get_template summary: Get one template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' put: operationId: update_template summary: Update template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/Template' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_template_content summary: Update template content parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateNewTemplate' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: trash_template summary: Move template to trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/copy/: post: operationId: copy_template summary: Copy template including preferences, deliveries parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyTemplate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CopyTemplate' multipart/form-data: schema: $ref: '#/components/schemas/CopyTemplate' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/delivery_count/: get: operationId: get_template_delivery_count summary: Get the count of deliveries linked to a template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeliveryCount' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/download/: get: operationId: download_template_file summary: Download template file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: version_id schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/editor_version/: patch: operationId: update_template_editor_version summary: Update the template editor version between v1 and v2 parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEditorVersion' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEditorVersion' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEditorVersion' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EditorVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/generate/: post: operationId: generate_document summary: Generate document from template parameters: - in: header name: X-Client schema: type: string description: Client Origin - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: download schema: type: string enum: - 'false' - file - 'true' - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: includeUrl schema: type: boolean - in: query name: output_type schema: type: string enum: - docx - html - pdf - png - pptx - xlsx - in: query name: version schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - generate requestBody: content: application/json: schema: type: object additionalProperties: {} security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TemplateGenerateResponse' description: file_url is included when download=true or no delivery configuration exists;otherwise, only file_name is returned. '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/generate_test_data/: get: operationId: generate_test_data summary: Generates a test data used for testing template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - generate security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/inline_image/: post: operationId: upload_inline_image_of_template summary: Upload inline image of template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/UploadTemplateImage' required: true security: - SessionAuthentication: [] responses: '200': description: No response body '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/migrate_to_native_syntax/: post: operationId: migrate_to_native_syntax summary: Migrate DocuSign template to native signature delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrateToNativeSyntaxRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MigrateToNativeSyntaxRequest' multipart/form-data: schema: $ref: '#/components/schemas/MigrateToNativeSyntaxRequest' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/MigrateToNativeSyntaxError' description: '' /dashboard/api/v2/templates/{id}/permanent_delete/: delete: operationId: delete_template_permanently summary: Delete a template permanently from trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/preview/: get: operationId: preview_template summary: Preview template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: format schema: type: string enum: - json - octet-stream - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: version_id schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/publish/: post: operationId: publish_latest_template_version summary: Publish latest template version parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/restore/: put: operationId: restore_template_from_trash summary: Restore a template from trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestoreTemplateResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/schema/: get: operationId: get_template_schema summary: Get template schema parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: version_id schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateSchema' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/schema/detail/: get: operationId: get_detailed_template_schema summary: Get template split schema parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: version_id schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateSchemaDetail' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/test/: post: operationId: test_document_generation summary: Test document generation parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true - in: query name: output_type schema: type: string enum: - docx - html - pdf - png - pptx - xlsx - in: query name: version_id schema: type: string description: Template version selector. Supports a numeric version id, `latest`, or `live`. tags: - generate requestBody: content: application/json: schema: type: object additionalProperties: {} security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TemplateTestResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{id}/test_data/: get: operationId: get_test_data summary: Get test data used for testing template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document. required: true tags: - generate security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: object additionalProperties: {} description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/deliveries/: get: operationId: list_template_deliveries summary: Get deliveries configured under this template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: path name: template_id schema: type: integer format: int32 required: true - in: query name: type schema: type: string enum: - aws_s3 - azure_blob_storage - box_drive - docu_sign - dropbox - email - eversign - google_drive - hellosign - one_drive - podio - sftp - sharepoint - sign_now - signable - signature - webhook - yousign - zoho_crm tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateDelivery' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_template_delivery summary: Create delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery requestBody: content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PolymorphicDelivery' multipart/form-data: schema: $ref: '#/components/schemas/PolymorphicDelivery' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/deliveries/{id}/: get: operationId: retrieve_template_delivery summary: Get delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' put: operationId: update_template_delivery summary: Update delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery requestBody: content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PolymorphicDelivery' multipart/form-data: schema: $ref: '#/components/schemas/PolymorphicDelivery' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_template_delivery summary: Delete delivery parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/deliveries/{id}/attachments/: post: operationId: upload_delivery_attachments summary: upload email delivery attachments parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/EmailDeliveryAttachment' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/deliveries/{id}/attachments/{attachment_id}/: get: operationId: download_delivery_attachment summary: download delivery attachment parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: attachment_id schema: type: string pattern: ^\d+$ required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_delivery_attachment summary: delete email delivery attachment parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: attachment_id schema: type: string pattern: ^\d+$ required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/deliveries/{id}/upgrade_docusign/: post: operationId: upgrade_docusign_delivery summary: Upgrade docusign delivery api version parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this delivery. required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - template_delivery security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolymorphicDelivery' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/: get: operationId: list_bulk_generation_tasks summary: List bulk generation tasks parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: status schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - in: path name: template_id schema: type: integer format: int32 required: true tags: - generate_bulk security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBulkGenList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/{id}/: get: operationId: get_bulk_generation_task summary: Get bulk generation task parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkGen' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/{id}/cancel/: put: operationId: cancel_bulk_generation_task summary: Cancel a bulk generation task parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkGen' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BulkGen' multipart/form-data: schema: $ref: '#/components/schemas/BulkGen' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkGen' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/{id}/draft/: get: operationId: get_bulk_generation_draft summary: Get a task saved as draft parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkGenData' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' put: operationId: update_bulk_generation_draft summary: update a template mapping parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkGenEdit' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BulkGenEdit' multipart/form-data: schema: $ref: '#/components/schemas/BulkGenEdit' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/{id}/get_mapping/: get: operationId: get_mapping_data_based_on_delimiter summary: Get Mapping Data based on Delimiter parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: delimiter schema: type: string description: A single character used to delimit columns in the batch process file. - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkGenData' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/{id}/trigger/: put: operationId: trigger_bulk_generation_draft summary: Trigger a bulk generation task parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer format: int32 description: Task id required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkGenEdit' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BulkGenEdit' multipart/form-data: schema: $ref: '#/components/schemas/BulkGenEdit' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkGen' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/sample_csv/: post: operationId: sample_csv summary: Generates a sample csv for the template using ai. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: format schema: type: string enum: - json - octet-stream - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate security: - SessionAuthentication: [] responses: '200': content: text/csv: schema: type: string format: binary description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' application/octet-stream: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' application/octet-stream: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' application/octet-stream: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' application/octet-stream: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/generate/bulk/upload/: post: operationId: upload_for_bulk_generation description: This will create a task in DRAFT mode. summary: Upload a new csv for bulk generate. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: integer format: int32 description: Template id required: true tags: - generate_bulk requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/BulkGenUpload' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/BulkGenData' description: '' '413': content: text/html: schema: description: Uploaded File Is Too Large. description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/merge_links/: get: operationId: list_generation_links description: URL to create document will be {host}/{path} summary: Get document create link path parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: integer format: int32 required: true tags: - generate security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DocumentMergeLink' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_template_merge_link summary: Create template merge link. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: string required: true tags: - generate security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DocumentMergeLink' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/merge_links/{id}/: delete: operationId: delete_template_merge_link description: Delete template merge link. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document merge link. required: true - in: path name: template_id schema: type: string required: true tags: - generate security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/permissions/: get: operationId: list_template_sharing summary: Get all shared permissions for specific template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: integer required: true tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_template_sharing_permission summary: Create template sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: template_id schema: type: integer required: true tags: - templates requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateSharing' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/TemplateSharing' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TemplateSharing' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/permissions/{id}/: get: operationId: get_template_sharing summary: Get specific permission details for given template parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this template sharing setting. required: true - in: path name: template_id schema: type: integer required: true tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_template_sharing_permission_content summary: Update template content partially parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this template sharing setting. required: true - in: path name: template_id schema: type: integer required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateTemplateSharing' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateTemplateSharing' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateTemplateSharing' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: revoke_template_sharing_permission summary: Revoke template sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this template sharing setting. required: true - in: path name: template_id schema: type: integer required: true tags: - templates security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/: get: operationId: list_template_versions summary: Get list of template versions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: starred schema: type: boolean - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTemplateVersionList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/: get: operationId: get_template_version summary: Get one template version parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/copy/: post: operationId: copy_template_from_version summary: Copy template from version including preferences, deliveries parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyTemplateFromVersion' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CopyTemplateFromVersion' multipart/form-data: schema: $ref: '#/components/schemas/CopyTemplateFromVersion' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/download/: get: operationId: download_template_version_file summary: Download template version file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: format schema: type: string enum: - json - octet-stream - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/minor_versions/: get: operationId: get_template_minor_versions summary: Get template minor versions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: starred schema: type: boolean - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateVersion' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/rename/: patch: operationId: update_template_version_name summary: Update template version name parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRenameTemplateVersion' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedRenameTemplateVersion' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRenameTemplateVersion' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/restore/: post: operationId: restore_template_version summary: Restore template version parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/set_as_live_version/: post: operationId: set_template_version_live summary: Set a template version to live version parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/{template_id}/versions/{id}/toggle_starred/: post: operationId: toggle_template_version_starred summary: Toggle template version starred parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this document content. required: true - in: path name: template_id schema: type: string required: true tags: - Template versioning security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateVersion' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/api/v2/templates/all/: get: operationId: list_all_templates description: Will return all templates without pagination, excluding templates in trashed summary: List all templates parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: delivery_type schema: type: array items: type: string enum: - aws_s3 - azure_blob_storage - box_drive - docu_sign - dropbox - email - eversign - google_drive - hellosign - one_drive - podio - sftp - sharepoint - sign_now - signable - signature - webhook - yousign - zoho_crm description: |+ Filter templates by delivery type explode: false style: form - in: query name: folder schema: type: integer - in: query name: output_type schema: type: string enum: - docx - html - jpeg - pdf - png - pptx - xlsx - in: query name: status schema: type: string enum: - active - test - in: query name: type schema: type: string tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Template' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/count/: get: operationId: get_user_created_templates_count summary: Get the count of templates created by the user. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: owner_id schema: type: string description: Owner Id of resource required: true tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateCount' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/move/: post: operationId: move_templates_to_another_folder description: Move templates to another folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - templates requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveTemplate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveTemplate' multipart/form-data: schema: $ref: '#/components/schemas/MoveTemplate' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '207': content: application/json: schema: $ref: '#/components/schemas/MoveTemplateResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/sharing_status/: get: operationId: templates_sharing_status_retrieve parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - templates security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingInfoTemplate' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/api/v2/templates/trash/: get: operationId: list_trashed_templates summary: List all templates in trash. parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer tags: - templates security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTemplateList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/banner_notifications/: get: operationId: list_banner_notifications tags: - general security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BannerNotification' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/envelope-exports/: get: operationId: get_created_envelope_export summary: Get created envelope export parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer tags: - esign security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEnvelopeBulkDownloadList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_envelope_export_task summary: Create envelope export task parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: status schema: type: string enum: - completed - created - declined - pending - voided - waiting_for_me description: Status filter tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeBulkDownload' security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EnvelopeBulkDownload' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/envelope-exports/{id}/download/: get: operationId: download_exported_envelopes summary: Download generated export envelopes if available parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - esign security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeExportDownloadResponse' description: The response contains file_name and file_url to download the generated export file. '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/: get: operationId: list_envelopes summary: Get list of envelopes parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: folder schema: type: integer description: Filter by folder id - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: array items: type: string enum: - completed - created - declined - pending - voided - waiting_for_me description: Filter by status explode: false style: form tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEnvelopeList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_envelope summary: Create a new envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/CreateEnvelope' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEnvelope' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Envelope' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/envelopes/{envelope_id}/documents/{id}/: patch: operationId: update_envelope_document summary: Update envelope document parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: envelope_id schema: type: string required: true - in: path name: id schema: type: string required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEnvelopeDocumentsUpdate' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeDocuments' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{envelope_id}/recipients/: get: operationId: list_envelope_recipients summary: Get list of envelope recipients parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: envelope_id schema: type: string required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEnvelopeRecipientList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_envelope_recipient summary: Create a new envelope recipient parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: envelope_id schema: type: string required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEnvelopeRecipient' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEnvelopeRecipient' multipart/form-data: schema: $ref: '#/components/schemas/CreateEnvelopeRecipient' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EnvelopeRecipient' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{envelope_id}/recipients/{id}/: patch: operationId: update_envelope_recipient summary: Partial update of envelope recipient parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: envelope_id schema: type: string required: true - in: path name: id schema: type: string required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeRecipient' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeRecipient' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_envelope_recipient summary: Delete an envelope recipient parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: envelope_id schema: type: string required: true - in: path name: id schema: type: string required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/: patch: operationId: update_envelope_config summary: Update envelope config parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnvelopeUpdate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEnvelopeUpdate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEnvelopeUpdate' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Envelope' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: trash_envelope summary: Move envelope to trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/attachment/{attachment_id}/download/: get: operationId: download_attachment summary: Download an individual attachment parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: attachment_id schema: type: string required: true - in: query name: format schema: type: string enum: - json - octet-stream - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/octet-stream: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' application/octet-stream: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' application/octet-stream: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' application/octet-stream: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/cancel/: post: operationId: cancel_envelope summary: Cancel an Envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeVoid' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EnvelopeVoid' multipart/form-data: schema: $ref: '#/components/schemas/EnvelopeVoid' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/copy/: post: operationId: copy_envelope summary: Copy an envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EnvelopeDetails' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/details/: get: operationId: envelope_details summary: details of an envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeDetails' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/documents/{document_id}/download/: get: operationId: download_envelope_file summary: Download envelope file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: document_id schema: type: string required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true - in: query name: response_type schema: type: string enum: - stream - url description: If stream, returns the document as a downloadable file. If url, returns JSON with file_url and file_name. tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeDocumentDownloadResponse' application/octet-stream: schema: type: string format: binary description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/documents/{document_id}/preview/: get: operationId: preview_envelope summary: Preview Envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: document_id schema: type: string required: true - in: query name: format schema: type: string enum: - json - pdf - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/pdf: schema: type: string format: binary description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' application/pdf: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' application/pdf: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' application/pdf: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' application/pdf: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/download/: get: operationId: download_envelope summary: Download all envelope documents parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: history schema: type: boolean description: Whether to include history in the response - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/zip: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/email_copy/: post: operationId: send_copy_via_email summary: send copy via email parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/SendEnvelopeViaEmail' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendEnvelopeViaEmail' multipart/form-data: schema: $ref: '#/components/schemas/SendEnvelopeViaEmail' required: true security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/history/: get: operationId: envelope_history summary: envelope history parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeHistory' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/permanent_delete/: delete: operationId: delete_envelope_permanently summary: Delete a envelope permanently from trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/recipient/{recipient_id}/attachments/download/: get: operationId: download_recipient_attachments summary: Download all attachments of an envelope recipient as a zip file parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: format schema: type: string enum: - json - zip - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true - in: path name: recipient_id schema: type: string required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/zip: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' application/zip: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' application/zip: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' application/zip: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/responses/: get: operationId: get_envelope_responses summary: Get consolidated field responses for an envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true - in: query name: recipient_id schema: type: string description: Filter responses by recipient id tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeResponses' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/restore/: post: operationId: restore_envelope_from_trash summary: Restore a envelope from trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Envelope' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/send/: post: operationId: send_envelope summary: Send an Envelope parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeUpdate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EnvelopeUpdate' multipart/form-data: schema: $ref: '#/components/schemas/EnvelopeUpdate' security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/send_reminder/: post: operationId: send_reminder summary: Send a reminder for Envelope Signers parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/{id}/signing-link/: get: operationId: get_signing_link summary: Get signing link for the envelope (sender self-sign) parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope. required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SigningLinkResponse' description: Signing link for the sender if available. Null otherwise. '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/envelopes/bulk-move/: post: operationId: bulk_move_envelopes summary: Bulk move envelopes across folders parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: folder schema: type: integer description: Restrict bulk move to envelopes currently in this folder - in: query name: status schema: type: string enum: - completed - created - declined - pending - voided - waiting_for_me description: Filter envelopes by status when moving all envelopes tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeBulkMove' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EnvelopeBulkMove' multipart/form-data: schema: $ref: '#/components/schemas/EnvelopeBulkMove' required: true security: - SessionAuthentication: [] responses: '207': content: application/json: schema: $ref: '#/components/schemas/BulkMoveEnvelopesResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/envelopes/count/: get: operationId: envelope_count_by_status summary: Get envelope count grouped by status parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeStatusCountResponse' description: Counts of envelopes grouped by status. '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' /dashboard/esign/envelopes/trash/: get: operationId: list_trashed_envelopes summary: List all envelopes in trash parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: page schema: type: integer tags: - esign security: - OAuthAuthentication: [] - SessionAuthentication: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEnvelopeList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/folders/: get: operationId: list_esign_folders summary: Get list of signature folders parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: permission schema: type: string enum: - manage - read - write description: Restrict folders to the requested permission level. - name: search required: false in: query description: A search term. schema: type: string tags: - esign-folders security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolder' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_esign_folder summary: Create signature folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-folders requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeFolder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EnvelopeFolder' multipart/form-data: schema: $ref: '#/components/schemas/EnvelopeFolder' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EnvelopeFolder' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/folders/{folder_id}/permissions/: get: operationId: list_esign_folder_sharing summary: Get all shared permissions for specific signature folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true tags: - esign security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolderSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_esign_folder_sharing_permission summary: Create signature folder sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true tags: - esign requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolderSharing' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolderSharing' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolderSharing' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/EnvelopeFolderSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/folders/{folder_id}/permissions/{id}/: get: operationId: get_esign_folder_sharing summary: Get specific permission details for given signature folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope folder sharing setting. required: true tags: - esign security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeFolderSharing' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: update_esign_folder_sharing_permission summary: Update signature folder sharing permission partially parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope folder sharing setting. required: true tags: - esign requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateEnvelopeFolderSharing' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeFolderSharing' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: revoke_esign_folder_sharing_permission summary: Revoke signature folder sharing permission parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: folder_id schema: type: integer required: true - in: path name: id schema: type: integer description: A unique integer value identifying this envelope folder sharing setting. required: true tags: - esign security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/folders/{id}/: patch: operationId: esign_folders_partial_update parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true tags: - esign-folders requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnvelopeFolder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEnvelopeFolder' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEnvelopeFolder' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvelopeFolder' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_esign_folder summary: Delete signature folder parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true tags: - esign-folders security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/global-settings/general/email-accounts/: get: operationId: get_email_accounts summary: Get verified email DNS accounts for eSign notifications parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifiedEmailDNSAccounts' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/general/get/: get: operationId: get_signature_general_settings summary: Get signature general settings parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ESignSettings' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/general/update/: patch: operationId: update_signature_general_settings summary: Update signature general settings parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedESignSettings' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedESignSettings' multipart/form-data: schema: $ref: '#/components/schemas/PatchedESignSettings' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ESignSettings' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/general/update-email-account/: patch: operationId: update_esign_email_account summary: Update email account for eSign notifications parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedESignEmailAccount' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedESignEmailAccount' multipart/form-data: schema: $ref: '#/components/schemas/PatchedESignEmailAccount' security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/webhooks/: get: operationId: list_esign_webhooks summary: Get list of webhooks parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedESignWebhookList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_esign_webhook summary: Create a new webhook parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/ESignWebhook' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ESignWebhook' multipart/form-data: schema: $ref: '#/components/schemas/ESignWebhook' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ESignWebhook' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/webhooks/{id}/: patch: operationId: update_esign_webhook summary: Partial update of an webhook parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true tags: - esign-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedESignWebhook' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedESignWebhook' multipart/form-data: schema: $ref: '#/components/schemas/PatchedESignWebhook' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ESignWebhook' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_esign_webhook summary: Delete an webhook parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/global-settings/webhooks/{webhook_id}/events/: get: operationId: list_esign_webhook_events summary: Get list of webhook events parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: event schema: type: array items: type: string enum: - envelope_completed - envelope_expired - envelope_voided - recipient_declined - recipient_signed - recipient_viewed description: Filter by event explode: false style: form - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: status_code schema: type: string enum: - failure - success description: Filter by status code explode: false style: form - in: path name: webhook_id schema: type: string required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedESignWebhookEventLogList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/webhooks/{webhook_id}/events/{id}/retry/: post: operationId: retry_webhook_event summary: Retry webhook event parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: string required: true - in: path name: webhook_id schema: type: string required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ESignWebhookEventLog' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/esign/global-settings/webhooks/generate-hmac-secret/: get: operationId: generate_hmac_secret summary: Generate HMAC secret parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateHMACSecretResponse' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/global-settings/webhooks/send-test-event/: post: operationId: send_test_event summary: Send test event to webhook parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - esign-settings requestBody: content: application/json: schema: $ref: '#/components/schemas/TestWebhookPayload' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TestWebhookPayload' multipart/form-data: schema: $ref: '#/components/schemas/TestWebhookPayload' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestWebhookEventResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/esign/permissions/folder/: get: operationId: get_esign_folder_permissions summary: Get e-sign folder permissions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: query name: ids schema: type: string - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - esign security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: type: object additionalProperties: type: array items: type: string enum: - read - write - manage example: '199': - read - write '1201': - read '90': - write description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/extensions/: get: operationId: list_extensions summary: Get extensions parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExtensionList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' post: operationId: create_extension summary: Create extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - extensions requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Extension' multipart/form-data: schema: $ref: '#/components/schemas/Extension' required: true security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/extensions/{extension_id}/responses/: get: operationId: get_extension_run_responses summary: Get extension run responses parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: extension_id schema: type: integer required: true - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExtensionRunList' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{extension_id}/responses/export/: get: operationId: export_extension_run_responses summary: Export extension run metadata and responses as Excel parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: extension_id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{id}/: get: operationId: get_extension summary: Get extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' put: operationId: update_extension summary: Edit extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions requestBody: content: application/json: schema: $ref: '#/components/schemas/Extension' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Extension' multipart/form-data: schema: $ref: '#/components/schemas/Extension' required: true security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' patch: operationId: extensions_partial_update parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedExtension' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedExtension' multipart/form-data: schema: $ref: '#/components/schemas/PatchedExtension' security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' delete: operationId: delete_extension summary: Delete extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{id}/archive/: put: operationId: archive_extension summary: Archive extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{id}/clone/: post: operationId: clone_extension summary: Clone extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneExtension' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CloneExtension' multipart/form-data: schema: $ref: '#/components/schemas/CloneExtension' security: - SessionAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{id}/permanent_delete/: delete: operationId: permanent_delete_extension summary: Permanently delete archived extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '204': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{id}/unarchive/: put: operationId: unarchive_extension summary: Unarchive extension parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true - in: path name: id schema: type: integer required: true tags: - extensions security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{workspace_unique}/{extension_unique}/config/: get: operationId: get_extension_config_by_unique_id summary: Get extension config by unique id parameters: - in: path name: extension_unique schema: type: string required: true - in: path name: workspace_unique schema: type: string required: true tags: - extensions security: - SessionAuthentication: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExtensionConfig' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/extensions/{workspace_unique}/{extension_unique}/execute/: post: operationId: run_extension_by_unique_id summary: Execute extension by unique id parameters: - in: path name: extension_unique schema: type: string required: true - in: path name: workspace_unique schema: type: string required: true tags: - extensions requestBody: content: application/json: schema: type: object additionalProperties: {} application/x-www-form-urlencoded: schema: type: object additionalProperties: {} multipart/form-data: schema: type: object additionalProperties: {} security: - SessionAuthentication: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/ExtensionRunResponse' description: '' '207': content: application/json: schema: $ref: '#/components/schemas/ExtensionRunResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: '' /dashboard/feature_flags/: get: operationId: get_feature_flags parameters: - in: header name: X-Workspace schema: type: string description: Workspace unique_key required: true tags: - general security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeatureFlags' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/meta/: get: operationId: get_app_meta tags: - general security: - SessionAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Meta' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/plans/: get: operationId: list_subscription_plans tags: - general security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Plan' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' /dashboard/tz/: get: operationId: list_timezones tags: - general security: - SessionAuthentication: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Timezone' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: '' components: schemas: AITemplateCreate: type: object properties: ai_prompt: type: string writeOnly: true template_title: type: string writeOnly: true maxLength: 120 template_description: type: string writeOnly: true nullable: true maxLength: 255 ai_response: type: string readOnly: true required: - ai_prompt - ai_response - template_title description: '' AITemplateEdit: type: object properties: ai_prompt: type: string writeOnly: true selected_content: type: string writeOnly: true ai_response: type: string readOnly: true required: - ai_prompt - ai_response - selected_content description: '' AccountDelivery: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 last_used_on: type: string format: date-time nullable: true template_info: $ref: '#/components/schemas/TemplateInfo' required: - id - name - template_info description: '' AddonPricingInfo: type: object properties: addon_id: type: string type: enum: - recurring - one_time type: string allowed_quantities: type: array items: type: integer tiers: type: array items: $ref: '#/components/schemas/AddonTier' required: - addon_id - allowed_quantities - tiers - type description: '' AddonPurchase: type: object properties: addon_id: enum: - esignature - signnow type: string quantity: type: integer required: - addon_id - quantity description: '' AddonTier: type: object properties: upto: type: string price: type: number format: double required: - price - upto description: '' AppendFiles: type: object properties: files: type: array items: type: string format: binary output_file_name: type: string required: - files description: '' AttachmentsConfig: type: object properties: allowed_types: type: string max_files: type: integer max_total_size: type: integer required: - allowed_types - max_files - max_total_size description: '' AuthToken: type: object properties: id: type: integer readOnly: true token: type: string readOnly: true name: type: string maxLength: 255 created_time: type: string format: date-time readOnly: true nullable: true last_used_time: type: string format: date-time readOnly: true nullable: true active: type: boolean default: true required: - created_time - id - last_used_time - name - token description: '' AzureBlobStorageDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true path: type: string nullable: true container_name: type: string description: Azure blob container name. maxLength: 64 required: - account - container_name - id - name BannerNotification: type: object properties: id: type: string name: type: string description: type: string action: $ref: '#/components/schemas/BannerNotificationAction' required: - action - description - id - name description: '' BannerNotificationAction: type: object properties: text: type: string attributes: type: object additionalProperties: {} required: - attributes - text description: '' BoxDriveDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true folder: type: string folder_id: type: string nullable: true maxLength: 100 required: - account - id - name BoxDrivePickerPayload: type: object properties: payload: type: string required: - payload description: '' BulkGen: type: object description: '' properties: id: type: integer readOnly: true errors: type: array items: $ref: '#/components/schemas/BulkGenTask' readOnly: true file_name: type: string readOnly: true status: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer minimum: 0 maximum: 32767 start_time: type: string format: date-time nullable: true end_time: type: string format: date-time nullable: true total: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true success: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true updated_time: type: string format: date-time readOnly: true nullable: true delimiter: type: string nullable: true maxLength: 1 created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true required: - created_by - errors - file_name - id - updated_by - updated_time BulkGenData: type: object properties: id: type: integer created_by: type: integer updated_by: type: integer data: type: object additionalProperties: {} row_count: type: integer suggested_mapping: type: object additionalProperties: {} delimiter: type: string required: - created_by - data - delimiter - id - row_count - suggested_mapping - updated_by description: '' BulkGenEdit: type: object properties: mapping: type: object additionalProperties: {} delimiter: type: string maxLength: 1 required: - delimiter - mapping description: '' BulkGenTask: type: object properties: status_message: type: string nullable: true maxLength: 255 description: '' BulkGenUpload: type: object properties: file: type: string format: binary delimiter: type: string maxLength: 1 required: - file description: '' BulkGenerateMeta: type: object properties: max_test_rows: type: integer required: - max_test_rows description: '' BulkMoveEnvelopesResponse: type: object properties: total_count: type: integer description: Number of envelopes requested for the bulk move moved_count: type: integer description: Number of envelopes moved successfully failure_count: type: integer description: Number of envelopes that were not moved failures: type: array items: $ref: '#/components/schemas/EnvelopeMoveFailureDetail' description: Failures grouped by reason required: - failure_count - failures - moved_count - total_count description: '' ChangeRole: type: object properties: role: enum: - owner - admin - manager - member - billing_manager type: string required: - role description: '' ChargebeeSubscription: type: object properties: plan_id: type: string readOnly: true nullable: true status: enum: - a - t - e - c - p type: string readOnly: true trial_end: type: string format: date-time readOnly: true billing_period_unit: type: string readOnly: true nullable: true current_term_start: type: string readOnly: true current_term_end: type: string readOnly: true unpaid_invoices: type: integer readOnly: true max_allowed_unpaid_invoices: type: integer readOnly: true overage_enabled: type: boolean documents_allowed: type: integer readOnly: true documents_created: type: integer readOnly: true can_extend_trial: type: boolean readOnly: true subscribed_on: type: string readOnly: true signnow_credits_allowed: type: integer readOnly: true signnow_credits_used: type: integer readOnly: true trial_signatures_allowed: type: integer readOnly: true trial_signatures_used: type: integer readOnly: true signatures_allowed: type: integer readOnly: true signatures_used: type: integer readOnly: true required: - billing_period_unit - can_extend_trial - current_term_end - current_term_start - documents_allowed - documents_created - max_allowed_unpaid_invoices - overage_enabled - plan_id - signatures_allowed - signatures_used - signnow_credits_allowed - signnow_credits_used - status - subscribed_on - trial_end - trial_signatures_allowed - trial_signatures_used - unpaid_invoices description: '' ChildDocumentMergeHistory: type: object properties: id: type: integer readOnly: true delivery_type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string status: enum: - pending - success - error type: string message: type: object additionalProperties: {} nullable: true delivery: type: integer nullable: true required: - delivery_type - id - status description: '' ChildTemplate: type: object properties: id: type: integer readOnly: true title: type: string readOnly: true description: type: string nullable: true maxLength: 255 type: enum: - docx - html - dpt_pdf - fillable_pdf - pptx - xlsx - g_document - g_presentation - g_spreadsheet type: string created_time: type: string format: date-time readOnly: true updated_time: type: string format: date-time readOnly: true nullable: true document_status: enum: - active - test type: string deleted_time: type: string format: date-time nullable: true use_v2_editor: type: boolean created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true folder: type: integer nullable: true required: - created_by - created_time - id - title - updated_by - updated_time description: '' CloneExtension: type: object properties: name: type: string maxLength: 255 description: '' ContentBlock: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 key: type: string readOnly: true type: enum: - docx - html type: string readOnly: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true created_time: type: string format: date-time readOnly: true updated_time: type: string format: date-time readOnly: true nullable: true use_v2_editor: type: boolean readOnly: true required: - created_by - created_time - id - key - name - type - updated_by - updated_time - use_v2_editor ContentBlockDetailByKeyResponse: type: object properties: name: type: string type: enum: - docx - html type: string schema: type: array items: $ref: '#/components/schemas/TemplateSchema' required: - name - schema - type description: '' ContentBlockEditorVersion: type: object properties: use_v2_editor: type: boolean description: '' ContentBlockSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer required: - id - user ConvertFileUrl: type: object properties: url: type: string format: uri type: type: string required: - type - url description: '' ConvertJsonRequest: type: object properties: output_file_name: type: string output_type: enum: - pdf - png - png.zip type: string file: $ref: '#/components/schemas/ConvertFileUrl' required: - file - output_file_name - output_type description: '' ConvertMultipartRequest: type: object properties: output_file_name: type: string output_type: enum: - pdf - png - png.zip type: string file: type: string format: binary required: - file - output_file_name - output_type description: '' CopyContentBlock: type: object properties: name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 key: type: string maxLength: 255 required: - key - name description: '' CopyTemplate: type: object properties: title: type: string maxLength: 255 folder: type: integer nullable: true required: - folder - title description: '' CopyTemplateFromVersion: type: object properties: folder: type: integer nullable: true title: type: string maxLength: 255 required: - title description: '' CreateEnvelope: type: object properties: name: type: string maxLength: 255 attachments: type: array items: type: string format: binary writeOnly: true maxItems: 3 folder: type: integer nullable: true required: - attachments - name description: '' CreateEnvelopeRecipient: type: object properties: email_address: type: string format: email maxLength: 254 order: type: integer maximum: 2147483647 minimum: 0 required: - email_address - order description: '' DeleteCurrentWorkspace: type: object properties: otp: type: string writeOnly: true required: - otp description: '' DeliveryAccount: type: object description: '' properties: id: type: integer readOnly: true sub_type: type: string readOnly: true used_by: type: integer readOnly: true name: type: string readOnly: true nullable: true type: enum: - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - box - zoho - hellosign - aws_s3 - signable - yousign - email - sftp - azure_storage type: string credentials: type: object additionalProperties: {} writeOnly: true is_expired: type: boolean readOnly: true updated_at: type: string format: date-time readOnly: true nullable: true use_for_images: type: boolean required: - credentials - id - is_expired - name - sub_type - type - updated_at - used_by DeliveryCount: type: object properties: delivery_count: type: integer description: Number of deliveries linked to the template required: - delivery_count description: '' DeliveryEmailAccount: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true nullable: true required: - id - name description: '' DocuSignDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer custom_tags: type: object additionalProperties: type: object additionalProperties: type: array items: type: object nullable: true signers: type: array minItems: 1 items: type: object properties: order: type: string recipient_type: type: string enum: - signer - agent - cc - editor name: type: string minLength: 1 is_email_delivery: type: boolean is_sms_delivery: type: boolean email_address: type: string format: email minLength: 5 country_code: type: string phone_number: type: string required: - recipient_type - name - is_email_delivery - is_sms_delivery reminder_settings: type: object nullable: true properties: reminder_delay: type: number reminder_frequency: type: number required: - reminder_delay - reminder_frequency overwrite_account_defaults: type: boolean default: false name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true subject: type: string nullable: true message: type: string nullable: true fullname_anchor_tags: type: boolean sequenced_signing: type: boolean expire_after: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true enable_optional_signers: type: boolean api_version: enum: - '2.0' - '2.1' type: string readOnly: true folder_id: type: string nullable: true maxLength: 52 folder_name: type: string nullable: true allow_reassign: type: boolean required: - account - api_version - id - name - signers DocuSignFolder: type: object properties: name: type: string type: type: string owner: $ref: '#/components/schemas/DocuSignFolderOwner' folderId: type: string uri: type: string itemCount: type: string hasSubFolders: type: string required: - folderId - hasSubFolders - itemCount - name - owner - type - uri description: '' DocuSignFolderOwner: type: object properties: userName: type: string userId: type: string email: type: string format: email required: - email - userId - userName description: '' DocumentMergeHistory: type: object properties: id: type: integer readOnly: true data: type: object additionalProperties: {} nullable: true template: allOf: - $ref: '#/components/schemas/ChildTemplate' readOnly: true nullable: true executed_deliveries: type: array items: $ref: '#/components/schemas/ChildDocumentMergeHistory' is_data_expired: type: boolean readOnly: true action: enum: - Merge - Append - Convert - Transform type: string readOnly: true is_document_expired: type: boolean readOnly: true created_file_name: type: string maxLength: 255 created_time: type: string format: date-time readOnly: true required: - action - created_file_name - created_time - executed_deliveries - id - is_data_expired - is_document_expired - template description: '' DocumentMergeLink: type: object properties: id: type: integer readOnly: true path: type: string readOnly: true required: - id - path description: '' Domain: type: object properties: id: type: integer readOnly: true domain_name: type: string maxLength: 255 txt_record: type: string maxLength: 60 is_txt_verified: type: boolean is_spf_verified: type: boolean spf_record: type: string readOnly: true required: - domain_name - id - spf_record - txt_record description: '' DomainFailure: type: object properties: spf_record: type: string txt_record: type: string required: - spf_record - txt_record description: '' DomainVerify: type: object properties: success: type: array items: enum: - txt_record - spf_record type: string failures: $ref: '#/components/schemas/DomainFailure' required: - failures - success description: '' DropboxDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true folder: type: string mode: enum: - add_as_new - conflict - overwrite type: string required: - account - id - name DynamicImage: type: object properties: token: type: string minLength: 1 page: type: integer default: 1 left: type: number format: double top: type: number format: double width: type: number format: double height: type: number format: double required: - height - left - token - top - width description: '' ESignReminderConfig: type: object properties: expiry: type: integer first_reminder: type: integer reminder_frequency: type: integer warn_before: type: integer required: - expiry - first_reminder - reminder_frequency - warn_before description: '' ESignSettings: type: object description: '' properties: email_account: allOf: - $ref: '#/components/schemas/FromEmailAccount' readOnly: true expiry: type: integer maximum: 32767 minimum: 0 description: Number of days until envelope expires first_reminder: type: integer maximum: 32767 minimum: 0 nullable: true description: Number of days before first reminder is sent reminder_frequency: type: integer maximum: 32767 minimum: 0 nullable: true description: Number of days between reminders warn_before: type: integer maximum: 32767 minimum: 0 description: Number of days before expiry to send warning required: - email_account ESignWebhook: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 url: type: string format: uri maxLength: 255 active: type: boolean event_subscriptions: type: array items: enum: - recipient_viewed - recipient_signed - recipient_declined - envelope_completed - envelope_expired - envelope_voided type: string hmac_secret: type: string nullable: true maxLength: 255 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true required: - created_at - created_by - id - name - updated_at - updated_by - url description: '' ESignWebhookEventLog: type: object properties: id: type: integer readOnly: true is_retryable: type: boolean readOnly: true event: enum: - recipient_viewed - recipient_signed - recipient_declined - envelope_completed - envelope_expired - envelope_voided type: string status_code: type: integer maximum: 32767 minimum: 0 nullable: true description: HTTP status code returned by the webhook last_triggered_at: type: string format: date-time readOnly: true attempts: type: integer maximum: 32767 minimum: 0 webhook: type: integer envelope: type: string required: - envelope - event - id - is_retryable - last_triggered_at - webhook description: '' EditorVersion: type: object properties: use_v2_editor: type: boolean description: '' EmailDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer nullable: true attachments: type: array items: $ref: '#/components/schemas/File' readOnly: true name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true from_email: type: string nullable: true maxLength: 255 to_email: type: array items: type: string maxLength: 200 cc: type: array items: type: string maxLength: 200 bcc: type: array items: type: string maxLength: 200 headers: type: object additionalProperties: {} nullable: true subject: type: string maxLength: 255 body: type: string enable_optional_recipients: type: boolean required: - account - attachments - id - name - to_email EmailDeliveryAttachment: type: object properties: attachments: type: array items: type: string format: binary required: - attachments description: '' Envelope: type: object properties: id: type: integer readOnly: true pending_signers_count: type: integer readOnly: true is_waiting_for_me: type: boolean readOnly: true source: type: string enum: - DOC_GEN - MANUAL_SEND readOnly: true envelope_id: type: string readOnly: true name: type: string maxLength: 255 status: enum: - created - pending - voided - declined - completed type: string cc: type: array items: type: string maxLength: 1000 sequenced_signing: type: boolean expiry: type: string format: date-time nullable: true first_reminder: type: string nullable: true description: 'ex: P3D to send first reminders after 3 days of sending invite' reminder_frequency: type: string nullable: true description: 'ex: P3D to send follow up reminders every 3 days' warn_before: type: string format: date-time nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true completed_at: type: string format: date-time nullable: true deleted_at: type: string format: date-time readOnly: true nullable: true archived_at: type: string format: date-time nullable: true declined_at: type: string format: date-time nullable: true voided_at: type: string format: date-time readOnly: true nullable: true reason: type: string nullable: true description: 'ex: Reason for Declining or Voiding provided by signer or sender respectively' minLength: 4 maxLength: 500 sender: type: integer voided_by: type: integer nullable: true updated_by: type: integer readOnly: true nullable: true folder: type: integer nullable: true required: - created_at - deleted_at - envelope_id - id - is_waiting_for_me - name - pending_signers_count - sender - source - updated_at - updated_by - voided_at description: '' EnvelopeBulkDownload: type: object description: '' properties: id: type: integer readOnly: true name: type: string readOnly: true status: enum: - pending - success - error type: string readOnly: true envelope_ids: type: array items: type: integer writeOnly: true created_time: type: string format: date-time readOnly: true filters: type: object additionalProperties: {} readOnly: true is_export_all: type: boolean writeOnly: true required: - created_time - filters - id - name - status EnvelopeBulkMove: type: object properties: envelope_ids: type: array items: type: integer writeOnly: true is_move_all: type: boolean writeOnly: true new_folder_id: type: integer writeOnly: true nullable: true required: - new_folder_id description: '' EnvelopeDetails: type: object properties: id: type: integer readOnly: true documents: type: array items: $ref: '#/components/schemas/EnvelopeDocuments' recipients: type: array items: $ref: '#/components/schemas/EnvelopeRecipient' envelope_id: type: string readOnly: true sn_envelope_id: type: string nullable: true maxLength: 255 sn_invite_id: type: string nullable: true maxLength: 255 name: type: string maxLength: 255 status: enum: - created - pending - voided - declined - completed type: string cc: type: array items: type: string maxLength: 1000 sequenced_signing: type: boolean expiry: type: string format: date-time nullable: true first_reminder: type: string nullable: true description: 'ex: P3D to send first reminders after 3 days of sending invite' reminder_frequency: type: string nullable: true description: 'ex: P3D to send follow up reminders every 3 days' warn_before: type: string format: date-time nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true completed_at: type: string format: date-time nullable: true deleted_at: type: string format: date-time nullable: true archived_at: type: string format: date-time nullable: true declined_at: type: string format: date-time nullable: true voided_at: type: string format: date-time nullable: true reason: type: string nullable: true description: 'ex: Reason for Declining or Voiding provided by signer or sender respectively' minLength: 4 maxLength: 500 audit_log_doc: type: string format: uri nullable: true source: enum: - 1 - 2 type: integer minimum: -2147483648 maximum: 2147483647 workspace: type: integer sender: type: integer voided_by: type: integer nullable: true updated_by: type: integer nullable: true folder: type: integer nullable: true required: - created_at - documents - envelope_id - id - name - recipients - sender - updated_at - workspace description: '' EnvelopeDocumentDownloadResponse: type: object properties: file_url: type: string format: uri file_name: type: string required: - file_name - file_url description: '' EnvelopeDocuments: type: object properties: id: type: integer readOnly: true document_name: type: string readOnly: true fields_meta: type: object additionalProperties: {} readOnly: true nullable: true required: - document_name - fields_meta - id description: '' EnvelopeExportDownloadResponse: type: object properties: file_url: type: string format: uri file_name: type: string required: - file_name - file_url description: '' EnvelopeFieldResponse: type: object properties: signer_id: type: string document_id: type: string nullable: true name: type: string type: type: string value: type: string nullable: true file_name: type: string nullable: true required: - name - signer_id - type description: '' EnvelopeFolder: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 50 created_by: type: integer readOnly: true created_at: type: string format: date-time readOnly: true nullable: true updated_by: type: integer readOnly: true nullable: true updated_at: type: string format: date-time readOnly: true nullable: true required: - created_at - created_by - id - name - updated_at - updated_by EnvelopeFolderSharing: type: object description: '' properties: id: type: integer readOnly: true user: type: integer permission: enum: - read - write - manage type: string required: - id - user EnvelopeHistory: type: object properties: envelope_id: type: string readOnly: true name: type: string maxLength: 255 status: enum: - created - pending - voided - declined - completed type: string cc: type: array items: type: string maxLength: 1000 created_at: type: string format: date-time readOnly: true signers: type: array items: type: string readOnly: true history: type: array items: $ref: '#/components/schemas/HistoryRecord' readOnly: true sender_email: type: string readOnly: true required: - created_at - envelope_id - history - name - sender_email - signers description: '' EnvelopeMoveFailureDetail: type: object properties: code: type: string detail: type: string ids: type: array items: type: integer count: type: integer required: - code - count - detail - ids description: '' EnvelopeRecipient: type: object properties: id: type: integer readOnly: true recipient_id: type: string readOnly: true email_address: type: string format: email maxLength: 254 subject: type: string maxLength: 255 email_body: type: string name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 status: enum: - created - failed - sent - viewed - completed - declined type: string created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true invited_at: type: string format: date-time nullable: true last_reminded_at: type: string format: date-time nullable: true completed_at: type: string format: date-time nullable: true workspace: type: integer envelope: type: integer required: - created_at - email_address - email_body - envelope - id - name - order - recipient_id - subject - updated_at - workspace description: '' EnvelopeResponses: type: object properties: data: type: array items: $ref: '#/components/schemas/EnvelopeFieldResponse' required: - data description: '' EnvelopeStatusCountResponse: type: object properties: created: type: integer pending: type: integer voided: type: integer declined: type: integer completed: type: integer required: - completed - created - declined - pending - voided description: '' EnvelopeUpdate: type: object properties: expiry: type: string format: date-time description: Expiry date and time for the envelope first_reminder: type: integer nullable: true description: Days after sending invite to send first reminder reminder_frequency: type: integer nullable: true description: Frequency in days for follow-up reminders warn_before: type: string format: date-time description: Days before expiry to send warning sequenced_signing: type: boolean use_default_reminders: type: boolean writeOnly: true default: false cc: type: array items: type: string format: email nullable: true description: '' EnvelopeVoid: type: object properties: reason: type: string maxLength: 255 required: - reason description: '' EversignDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer signers: type: array minItems: 1 items: type: object properties: pin: type: string name: type: string minLength: 1 email: type: string format: email order: type: string required: - name - email recipients: type: array minItems: 0 items: type: object properties: name: type: string minLength: 1 email: type: string format: email required: - name - email nullable: true name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true title: type: string nullable: true message: type: string nullable: true use_signer_order: type: boolean reminders: type: boolean require_all_signers: type: boolean expires_in: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true enable_optional_signers: type: boolean required: - account - id - name - signers ExchangeSessionResponse: type: object properties: code: type: string required: - code description: '' ExportMergeHistory: type: object description: '' properties: id: type: integer readOnly: true name: type: string readOnly: true from_date: type: string format: date to_date: type: string format: date status: enum: - pending - success - error type: string required: - from_date - id - name - to_date Extension: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: enum: - form_v1 type: string unique_id: type: string readOnly: true is_public: type: boolean config: type: object additionalProperties: {} created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true archived_at: type: string format: date-time readOnly: true nullable: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true required: - archived_at - created_at - created_by - id - name - type - unique_id - updated_at - updated_by ExtensionConfig: type: object properties: config: type: object additionalProperties: {} required: - config description: '' ExtensionRun: type: object properties: user_id: type: integer nullable: true readOnly: true data: type: object additionalProperties: {} started_on: type: string format: date-time readOnly: true ended_on: type: string format: date-time readOnly: true nullable: true status: enum: - queued - in_progress - success - partial_success - failed type: string request_id: type: string nullable: true maxLength: 255 origin: type: string nullable: true maxLength: 255 required: - ended_on - started_on - user_id description: '' ExtensionRunError: type: object properties: template_id: type: integer nullable: true error: type: string required: - error - template_id description: '' ExtensionRunResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/ExtensionRunResult' errors: type: array items: $ref: '#/components/schemas/ExtensionRunError' required: - errors - results description: '' ExtensionRunResult: type: object properties: template_id: type: integer file_name: type: string file_url: type: string format: uri required: - file_name - template_id description: '' FeatureFlags: type: object properties: template_versioning_enabled: type: boolean required: - template_versioning_enabled description: '' File: type: object description: '' properties: id: type: integer readOnly: true path: type: string writeOnly: true maxLength: 255 name: type: string maxLength: 255 tag: type: string writeOnly: true maxLength: 255 size: type: integer readOnly: true required: - id - name - path - size - tag FileUploadMeta: type: object properties: email_attachments: $ref: '#/components/schemas/AttachmentsConfig' required: - email_attachments description: '' FillablePdfSettings: type: object properties: width: type: number format: double height: type: number format: double no_of_pages: type: integer maximum: 2147483647 minimum: 0 dynamic_images: type: object additionalProperties: {} writeOnly: true nullable: true required: - height - no_of_pages - width description: '' Folder: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 50 created_time: type: string format: date-time readOnly: true nullable: true updated_time: type: string format: date-time readOnly: true nullable: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true required: - created_by - created_time - id - name - updated_by - updated_time FolderCount: type: object properties: folders_count: type: integer required: - folders_count description: '' FolderSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer required: - id - user ForbiddenError: type: object properties: detail: type: string required: - detail description: '' FromEmailAccount: type: object properties: id: type: integer nullable: true email: type: string format: email required: - email - id description: '' GalleryCategory: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 100 required: - id - name description: '' GenerateHMACSecretResponse: type: object properties: hmac_secret: type: string description: Generated HMAC secret required: - hmac_secret description: '' GlobalPermission: type: object properties: templates: type: boolean folders: type: boolean workspace: type: boolean workspace:update: type: boolean workspace:delete: type: boolean billing: type: boolean team:manage: type: boolean integrations: type: boolean reports: type: boolean api_settings: type: boolean eSignatures: type: boolean extensions: type: boolean delivery:create: type: boolean settings:esign:general: type: boolean settings:esign:webhook: type: boolean required: - api_settings - billing - delivery:create - eSignatures - extensions - folders - integrations - reports - settings:esign:general - settings:esign:webhook - team:manage - templates - workspace - workspace:delete - workspace:update description: '' GoogleDriveDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true folder: type: string description: Base folder name folder_id: type: string nullable: true description: Base folder id maxLength: 100 path: type: string nullable: true description: Dynamic folder path maxLength: 255 required: - account - id - name GoogleDrivePickerPayload: type: object properties: payload: type: string required: - payload description: '' HelloSignDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer signers: type: array minItems: 1 items: type: object properties: name: type: string minLength: 1 email_address: type: string format: email required: - name - email_address name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true title: type: string nullable: true subject: type: string nullable: true message: type: string nullable: true cc: type: array items: type: string maxLength: 1000 use_text_tags: type: boolean hide_text_tags: type: boolean sequenced_signing: type: boolean enable_optional_signers: type: boolean required: - account - id - name - signers HistoryRecord: type: object properties: id: type: integer readOnly: true event_name: enum: - created - invited - send_failed - resent - viewed - signed - completed - declined - voided - recipient_changed type: string event_meta: type: object additionalProperties: {} nullable: true server_time: type: string format: date-time client_time: type: string format: date-time ip_address: type: string nullable: true created_at: type: string format: date-time readOnly: true description: Timestamp when this history log was created actor: type: string readOnly: true required: - actor - client_time - created_at - event_name - id - server_time description: '' HostedPage: type: object properties: url: type: string format: uri required: - url description: '' InitiateAuthorizationSequence: type: object properties: action_name: enum: - delete workspace - transfer ownership type: string default: delete workspace description: '' Invitation: type: object properties: id: type: integer readOnly: true email: type: string format: email maxLength: 254 role: enum: - admin - manager - member - billing_manager type: string created_at: type: string format: date-time readOnly: true expires_at: type: string format: date-time readOnly: true workspace: type: string readOnly: true is_accepted: type: boolean readOnly: true nullable: true invite_key: type: string readOnly: true sender: type: string readOnly: true expired: type: string readOnly: true required: - created_at - email - expired - expires_at - id - invite_key - is_accepted - role - sender - workspace description: '' MergeHistory: type: object properties: id: type: integer readOnly: true template: allOf: - $ref: '#/components/schemas/ChildTemplate' readOnly: true nullable: true data: type: object additionalProperties: {} data_expired: type: boolean document_expired: type: boolean mode: type: string created_file_name: type: string delivery_type: type: string maxLength: 255 status: enum: - pending - success - error type: string created_time: type: string format: date-time readOnly: true message: type: object additionalProperties: {} nullable: true callback_status: enum: - success - fail - null type: string nullable: true callback_failure_message: type: string nullable: true delivery: type: integer nullable: true required: - created_file_name - created_time - data - data_expired - delivery_type - document_expired - id - mode - status - template description: '' Meta: type: object properties: file_uploads: $ref: '#/components/schemas/FileUploadMeta' batch_process_max_allowed_test_rows: $ref: '#/components/schemas/BulkGenerateMeta' iam: type: string esign_reminder_defaults: $ref: '#/components/schemas/ESignReminderConfig' required: - batch_process_max_allowed_test_rows - esign_reminder_defaults - file_uploads - iam description: '' MigrateSessionResponse: type: object properties: status: type: string required: - status description: '' MigrateToNativeSyntaxError: type: object properties: detail: type: string required: - detail description: '' MigrateToNativeSyntaxRequest: type: object properties: provider: enum: - docusign type: string default: docusign title: type: string description: '' MoveTemplate: type: object properties: template_ids: type: array items: type: integer new_folder_id: type: integer nullable: true required: - new_folder_id - template_ids description: '' MoveTemplateResponse: type: object properties: success: type: array items: type: integer description: List of successfully moved template IDs failures: type: object additionalProperties: $ref: '#/components/schemas/TemplateMoveFailureDetail' description: Mapping of failed template IDs to error messages required: - failures - success description: '' NewAuthTokenResponse: type: object properties: id: type: integer readOnly: true token: type: string readOnly: true name: type: string maxLength: 255 created_time: type: string format: date-time readOnly: true nullable: true last_used_time: type: string format: date-time nullable: true active: type: boolean secret: type: string readOnly: true nullable: true required: - created_time - id - name - secret - token description: '' NewContentBlock: type: object description: '' properties: name: type: string maxLength: 255 key: type: string maxLength: 255 file: type: string format: binary description: type: string nullable: true maxLength: 255 required: - file - key - name NewTemplate: type: object description: '' properties: file: type: string format: binary folder: type: integer nullable: true title: type: string maxLength: 255 output_type: enum: - html - pdf - jpeg - png - docx - pptx - xlsx type: string description: type: string nullable: true maxLength: 255 template_gallery_id: type: integer required: - output_type - title NotFoundError: type: object properties: detail: type: string required: - detail description: '' NpsNextReminder: type: object properties: days: type: integer required: - days description: '' NpsRating: type: object properties: nps_rating: type: integer maximum: 10 minimum: 0 nullable: true description: '' OneDriveDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true folder: type: string required: - account - id - name Organization: type: object properties: name: type: string readOnly: true subdomain: type: string readOnly: true logo: type: string format: uri readOnly: true nullable: true required: - logo - name - subdomain description: '' PDFTransformInput: type: object properties: id: type: string file_url: type: string format: uri required: - file_url - id description: '' PDFTransformJsonRequest: type: object properties: inputs: type: array items: $ref: '#/components/schemas/PDFTransformInput' operations: type: array items: type: object additionalProperties: {} output_file_name: type: string required: - inputs - operations - output_file_name description: '' PDFTransformMultipartRequest: type: object properties: inputs: type: array items: type: string format: binary input_ids: type: array items: type: string operations: type: array items: type: object additionalProperties: {} output_file_name: type: string required: - input_ids - inputs - operations - output_file_name description: '' PaginatedAccountDeliveryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/AccountDelivery' PaginatedBulkGenList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/BulkGen' PaginatedContentBlockList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ContentBlock' PaginatedDocumentMergeHistoryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/DocumentMergeHistory' PaginatedESignWebhookEventLogList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ESignWebhookEventLog' PaginatedESignWebhookList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ESignWebhook' PaginatedEnvelopeBulkDownloadList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/EnvelopeBulkDownload' PaginatedEnvelopeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Envelope' PaginatedEnvelopeRecipientList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/EnvelopeRecipient' PaginatedExtensionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Extension' PaginatedExtensionRunList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ExtensionRun' PaginatedMergeHistoryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/MergeHistory' PaginatedTemplateInfoList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/TemplateInfo' PaginatedTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Template' has_docusign_templates: type: boolean PaginatedTemplateVersionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/TemplateVersion' PatchedContentBlockEditorVersion: type: object properties: use_v2_editor: type: boolean description: '' PatchedDomain: type: object properties: id: type: integer readOnly: true domain_name: type: string maxLength: 255 txt_record: type: string maxLength: 60 is_txt_verified: type: boolean is_spf_verified: type: boolean spf_record: type: string readOnly: true description: '' PatchedESignEmailAccount: type: object properties: email_account: type: integer nullable: true description: '' PatchedESignSettings: type: object description: '' properties: email_account: allOf: - $ref: '#/components/schemas/FromEmailAccount' readOnly: true expiry: type: integer maximum: 32767 minimum: 0 description: Number of days until envelope expires first_reminder: type: integer maximum: 32767 minimum: 0 nullable: true description: Number of days before first reminder is sent reminder_frequency: type: integer maximum: 32767 minimum: 0 nullable: true description: Number of days between reminders warn_before: type: integer maximum: 32767 minimum: 0 description: Number of days before expiry to send warning PatchedESignWebhook: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 url: type: string format: uri maxLength: 255 active: type: boolean event_subscriptions: type: array items: enum: - recipient_viewed - recipient_signed - recipient_declined - envelope_completed - envelope_expired - envelope_voided type: string hmac_secret: type: string nullable: true maxLength: 255 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true description: '' PatchedEditorVersion: type: object properties: use_v2_editor: type: boolean description: '' PatchedEnvelopeDocumentsUpdate: type: object properties: fields_meta: type: object additionalProperties: {} nullable: true description: '' PatchedEnvelopeFolder: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 50 created_by: type: integer readOnly: true created_at: type: string format: date-time readOnly: true nullable: true updated_by: type: integer readOnly: true nullable: true updated_at: type: string format: date-time readOnly: true nullable: true PatchedEnvelopeUpdate: type: object properties: expiry: type: string format: date-time description: Expiry date and time for the envelope first_reminder: type: integer nullable: true description: Days after sending invite to send first reminder reminder_frequency: type: integer nullable: true description: Frequency in days for follow-up reminders warn_before: type: string format: date-time description: Days before expiry to send warning sequenced_signing: type: boolean use_default_reminders: type: boolean writeOnly: true default: false cc: type: array items: type: string format: email nullable: true description: '' PatchedExtension: type: object description: '' properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: enum: - form_v1 type: string unique_id: type: string readOnly: true is_public: type: boolean config: type: object additionalProperties: {} created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true archived_at: type: string format: date-time readOnly: true nullable: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true PatchedRenameTemplateVersion: type: object properties: name: type: string description: '' PatchedUpdateContentBlockSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer readOnly: true PatchedUpdateEnvelopeFolderSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string PatchedUpdateEnvelopeRecipient: type: object properties: email_address: type: string format: email maxLength: 254 subject: type: string maxLength: 255 email_body: type: string name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: '' PatchedUpdateFolderSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer readOnly: true PatchedUpdateNewContentBlock: type: object description: '' properties: name: type: string maxLength: 255 file: type: string format: binary PatchedUpdateNewTemplate: type: object description: '' properties: file: type: string format: binary PatchedUpdateTemplateSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer readOnly: true PatchedUpdateUser: type: object properties: locale: type: string nullable: true maxLength: 5 theme: enum: - light - dark - system type: string description: '' PatchedWorkspace: type: object properties: id: type: integer readOnly: true org_name: type: string maxLength: 60 unique_key: type: string readOnly: true role: type: string readOnly: true timezone: enum: - Pacific/Midway - America/Adak - Pacific/Honolulu - Pacific/Marquesas - America/Anchorage - America/Tijuana - America/Los_Angeles - America/Phoenix - America/Chihuahua - America/Denver - America/Belize - America/Chicago - Pacific/Easter - America/Mexico_City - America/Regina - America/Bogota - America/Cancun - America/New_York - America/Port-au-Prince - America/Havana - America/Indiana/Indianapolis - America/Asuncion - America/Halifax - America/Caracas - America/Cuiaba - America/Manaus - America/Santiago - America/Grand_Turk - America/St_Johns - America/Fortaleza - America/Sao_Paulo - America/Cayenne - America/Buenos_Aires - America/Godthab - America/Montevideo - America/Miquelon - America/Bahia - America/Noronha - Atlantic/Azores - Atlantic/Cape_Verde - UTC - Africa/Casablanca - Europe/London - Africa/Monrovia - Europe/Amsterdam - Europe/Belgrade - Europe/Brussels - Europe/Warsaw - Africa/Algiers - Africa/Windhoek - Asia/Amman - Europe/Athens - Asia/Beirut - Africa/Cairo - Asia/Damascus - Asia/Gaza - Africa/Harare - Europe/Helsinki - Asia/Jerusalem - Europe/Kaliningrad - Africa/Tripoli - Asia/Baghdad - Asia/Istanbul - Asia/Kuwait - Europe/Minsk - Europe/Moscow - Africa/Nairobi - Asia/Tehran - Asia/Muscat - Europe/Astrakhan - Asia/Baku - Europe/Samara - Indian/Mauritius - Asia/Tbilisi - Asia/Yerevan - Asia/Kabul - Asia/Tashkent - Asia/Yekaterinburg - Asia/Karachi - Asia/Kolkata - Asia/Colombo - Asia/Katmandu - Asia/Almaty - Asia/Dhaka - Asia/Rangoon - Asia/Novosibirsk - Asia/Bangkok - Asia/Barnaul - Asia/Hovd - Asia/Krasnoyarsk - Asia/Tomsk - Asia/Chongqing - Asia/Irkutsk - Asia/Kuala_Lumpur - Australia/Perth - Asia/Taipei - Asia/Ulaanbaatar - Asia/Pyongyang - Australia/Eucla - Asia/Chita - Asia/Tokyo - Asia/Seoul - Asia/Yakutsk - Australia/Adelaide - Australia/Darwin - Australia/Brisbane - Australia/Canberra - Pacific/Guam - Australia/Hobart - Asia/Vladivostok - Australia/Lord_Howe - Pacific/Bougainville - Asia/Srednekolymsk - Asia/Magadan - Pacific/Norfolk - Asia/Sakhalin - Pacific/Guadalcanal - Asia/Anadyr - Pacific/Auckland - Pacific/Fiji - Pacific/Chatham - Pacific/Tongatapu - Pacific/Apia - Pacific/Kiritimati type: string readOnly: true plan_id: type: string nullable: true readOnly: true plan_status: type: string readOnly: true active: type: boolean readOnly: true mfa_enforced: type: boolean readOnly: true created_time: type: string format: date-time readOnly: true description: '' Plan: type: object properties: plan_id: type: string readOnly: true documents_allowed: type: integer readOnly: true price: type: integer readOnly: true billing_period_unit: enum: - year - month type: string readOnly: true required: - billing_period_unit - documents_allowed - plan_id - price description: '' PolymorphicDelivery: oneOf: - $ref: '#/components/schemas/EmailDelivery' - $ref: '#/components/schemas/WebhookDelivery' - $ref: '#/components/schemas/SignatureDelivery' - $ref: '#/components/schemas/DropboxDelivery' - $ref: '#/components/schemas/OneDriveDelivery' - $ref: '#/components/schemas/SharepointDelivery' - $ref: '#/components/schemas/SignNowDelivery' - $ref: '#/components/schemas/GoogleDriveDelivery' - $ref: '#/components/schemas/S3Delivery' - $ref: '#/components/schemas/HelloSignDelivery' - $ref: '#/components/schemas/DocuSignDelivery' - $ref: '#/components/schemas/EversignDelivery' - $ref: '#/components/schemas/SignableDelivery' - $ref: '#/components/schemas/YouSignDelivery' - $ref: '#/components/schemas/SftpDelivery' - $ref: '#/components/schemas/AzureBlobStorageDelivery' - $ref: '#/components/schemas/BoxDriveDelivery' discriminator: propertyName: type mapping: email: '#/components/schemas/EmailDelivery' webhook: '#/components/schemas/WebhookDelivery' signature: '#/components/schemas/SignatureDelivery' dropbox: '#/components/schemas/DropboxDelivery' one_drive: '#/components/schemas/OneDriveDelivery' sharepoint: '#/components/schemas/SharepointDelivery' sign_now: '#/components/schemas/SignNowDelivery' google_drive: '#/components/schemas/GoogleDriveDelivery' aws_s3: '#/components/schemas/S3Delivery' hellosign: '#/components/schemas/HelloSignDelivery' docu_sign: '#/components/schemas/DocuSignDelivery' eversign: '#/components/schemas/EversignDelivery' signable: '#/components/schemas/SignableDelivery' yousign: '#/components/schemas/YouSignDelivery' sftp: '#/components/schemas/SftpDelivery' azure_blob_storage: '#/components/schemas/AzureBlobStorageDelivery' box_drive: '#/components/schemas/BoxDriveDelivery' PromptSuggestions: type: object properties: template_title: type: string writeOnly: true template_description: type: string writeOnly: true nullable: true prompts: type: array items: type: string readOnly: true required: - prompts - template_title description: '' RenewSubscription: type: object properties: upgrade_message: type: string maxLength: 200 description: '' RestoreTemplateResponse: type: object properties: status: type: string required: - status description: '' RetentionPreference: type: object properties: merge_data: type: string generated_document: type: string description: '' S3Delivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true bucket: type: string maxLength: 2000 key_prefix: type: string nullable: true maxLength: 2000 region: type: string nullable: true maxLength: 50 object_metadata: type: object additionalProperties: {} nullable: true required: - account - bucket - id - name SaveCustomerFeedback: type: object properties: feedback: type: object nullable: false properties: challenges_faced: type: array feature_improvement: type: string required: - challenges_faced required: - feedback description: '' SendEmailAccountAuthorizationOTP: type: object properties: action_name: enum: - verify - update type: string email: type: string format: email nullable: true required: - action_name description: '' SendEnvelopeViaEmail: type: object properties: emails: type: array items: type: string format: email nullable: true required: - emails description: '' SendTestSmtpMail: type: object properties: smtp_server_address: type: string maxLength: 255 smtp_server_username: type: string maxLength: 255 smtp_server_password: type: string maxLength: 255 smtp_port: type: integer smtp_encryption_type: enum: - TLS - SSL type: string email: type: string format: email required: - email - smtp_encryption_type - smtp_port - smtp_server_address - smtp_server_password - smtp_server_username description: '' SftpDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true path: type: string nullable: true maxLength: 255 required: - account - id - name SharepointDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true folder_id: type: string maxLength: 100 drive_id: type: string maxLength: 100 path: type: string required: - account - drive_id - folder_id - id - name - path SharepointPickerPayload: type: object properties: payload: type: string required: - payload description: '' SharingInfoFolder: type: object properties: id: type: integer readOnly: true is_shared: type: boolean readOnly: true required: - id - is_shared description: '' SharingInfoTemplate: type: object properties: id: type: integer readOnly: true is_shared: type: boolean readOnly: true required: - id - is_shared description: '' SignNowDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer signers: type: array minItems: 1 items: type: object properties: order: type: string role: type: string minLength: 1 email: type: string format: email required: - role - email name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true subject: type: string nullable: true message: type: string nullable: true cc: type: array items: type: string maxLength: 1000 sequenced_signing: type: boolean enable_optional_signers: type: boolean required: - account - id - name - signers SignableDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer parties: type: array minItems: 1 items: type: object properties: party_name: type: string minLength: 1 party_email: type: string format: email party_role: type: string enum: - signer - copy required: - party_name - party_email - party_role name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true title: type: string nullable: true expire_after: type: integer maximum: 2147483647 minimum: 1 nullable: true remind_after: type: integer maximum: 2147483647 minimum: 1 nullable: true required: - account - id - name - parties SignatureDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 signers: type: array minItems: 1 items: type: object properties: id: type: number order: type: number name: type: string minLength: 3 email: type: string format: email required: - id - name - email use_default_reminders: type: boolean default: false expiry: type: integer nullable: true first_reminder: type: integer nullable: true reminder_frequency: type: integer nullable: true warn_before: type: integer nullable: true sender: type: integer nullable: true sender_mode: enum: - fixed - smart type: string folder_name: type: string nullable: true readOnly: true name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true subject: type: string nullable: true message: type: string nullable: true cc: type: array items: type: string maxLength: 1000 sequenced_signing: type: boolean enable_optional_signers: type: boolean folder: type: integer nullable: true required: - folder_name - id - name - signers SigningLinkResponse: type: object properties: signing_link: type: string format: uri required: - signing_link description: '' SurveyPrompt: type: object properties: show_survey_prompt: type: boolean readOnly: true required: - show_survey_prompt description: '' TeamMember: type: object properties: id: type: integer readOnly: true user: allOf: - $ref: '#/components/schemas/User' readOnly: true role: enum: - owner - admin - manager - member - billing_manager type: string deactivated_at: type: string format: date-time nullable: true required: - id - user description: '' Template: type: object description: '' properties: id: type: integer readOnly: true preferences: $ref: '#/components/schemas/TemplateSettings' folder: allOf: - $ref: '#/components/schemas/Folder' nullable: true has_docusign_delivery: type: boolean readOnly: true published: type: boolean readOnly: true title: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 type: enum: - docx - html - dpt_pdf - fillable_pdf - pptx - xlsx - g_document - g_presentation - g_spreadsheet type: string readOnly: true created_time: type: string format: date-time readOnly: true updated_time: type: string format: date-time readOnly: true nullable: true document_status: enum: - active - test type: string deleted_time: type: string format: date-time readOnly: true nullable: true use_v2_editor: type: boolean readOnly: true created_by: type: integer readOnly: true updated_by: type: integer readOnly: true nullable: true required: - created_by - created_time - deleted_time - has_docusign_delivery - id - published - title - type - updated_by - updated_time - use_v2_editor TemplateCount: type: object properties: templates_count: type: integer required: - templates_count description: '' TemplateDelivery: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string readOnly: true required: - id - name - type description: '' TemplateGallery: type: object properties: id: type: integer readOnly: true image_path: type: string readOnly: true file_type: type: string readOnly: true category: $ref: '#/components/schemas/GalleryCategory' title: type: string maxLength: 50 description: type: string nullable: true maxLength: 255 images_count: type: integer maximum: 32767 minimum: 0 nullable: true required: - category - file_type - id - image_path - title description: '' TemplateGenerateResponse: type: object properties: file_url: type: string format: uri file_name: type: string required: - file_name - file_url description: '' TemplateInfo: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true status: type: string readOnly: true type: type: string readOnly: true required: - id - name - status - type description: '' TemplateMoveFailureDetail: type: object properties: detail: type: string required: - detail description: '' TemplateSchema: type: object properties: name: type: string type: enum: - string - array - object - generic type: string rType: enum: - content_block type: string generics: enum: - string - array - object - generic type: string fields: type: array items: $ref: '#/components/schemas/TemplateSchema' required: - fields - generics - name - type description: '' TemplateSchemaDetail: type: object properties: content: type: array items: $ref: '#/components/schemas/TemplateSchema' content_blocks_schema: type: object additionalProperties: type: array items: $ref: '#/components/schemas/TemplateSchema' description: A mapping of content block keys to their respective schema. other: type: array items: $ref: '#/components/schemas/TemplateSchema' required: - content - content_blocks_schema - other description: '' TemplateSettings: type: object properties: margin: type: object additionalProperties: false properties: top: type: number format: float minimum: 0 maximum: 11 left: type: number format: float minimum: 0 maximum: 8 right: type: number format: float minimum: 0 maximum: 8 bottom: type: number format: float minimum: 0 maximum: 11 nullable: true timezone: type: string info: allOf: - $ref: '#/components/schemas/FillablePdfSettings' readOnly: true dynamic_images: type: array items: $ref: '#/components/schemas/DynamicImage' nullable: true output_file_name: type: string maxLength: 255 output_type: enum: - html - pdf - jpeg - png - docx - pptx - xlsx type: string password: type: string nullable: true maxLength: 255 format: enum: - A3 - A4 - A5 - Legal - Letter - Tabloid - Custom type: string orientation: enum: - portrait - landscape type: string header: type: string nullable: true footer: type: string nullable: true width: type: number format: double maximum: 180 minimum: 0.4 nullable: true height: type: number format: double maximum: 250 minimum: 0.5 nullable: true auto_number: type: integer maximum: 9223372036854775807 minimum: 1 format: int64 nullable: true flatten_pdf: type: boolean emulate_mode: enum: - print - screen - null type: string nullable: true required: - info description: '' TemplateSharing: type: object description: '' properties: id: type: integer readOnly: true permission: enum: - read - write - manage type: string user: type: integer required: - id - user TemplateTestResponse: type: object properties: file_url: type: string format: uri file_name: type: string required: - file_name - file_url description: '' TemplateVersion: type: object properties: id: type: integer readOnly: true name: type: string nullable: true maxLength: 255 version_type: enum: - major - minor - null type: string nullable: true starred: type: boolean live: type: boolean created_time: type: string format: date-time readOnly: true created_by_user_name: type: string readOnly: true required: - created_by_user_name - created_time - id description: '' TestContentBlock: type: object properties: file_url: type: string format: uri file_name: type: string required: - file_name - file_url description: '' TestWebhookEventResponse: type: object properties: status_code: type: integer description: HTTP status code returned by the webhook endpoint required: - status_code description: '' TestWebhookPayload: type: object properties: url: type: string format: uri description: Webhook URL hmac_secret: type: string description: HMAC secret for signing the request required: - url description: '' Timezone: type: object properties: name: type: string readOnly: true tz: type: string readOnly: true required: - name - tz description: '' UnauthenticatedError: type: object properties: detail: type: string required: - detail description: '' UpdateDeliveryAccount: type: object description: '' properties: id: type: integer readOnly: true sub_type: type: string readOnly: true used_by: type: integer readOnly: true name: type: string readOnly: true nullable: true type: enum: - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - box - zoho - hellosign - aws_s3 - signable - yousign - email - sftp - azure_storage type: string readOnly: true credentials: type: object additionalProperties: {} writeOnly: true is_expired: type: boolean readOnly: true updated_at: type: string format: date-time readOnly: true nullable: true use_for_images: type: boolean required: - credentials - id - is_expired - name - sub_type - type - updated_at - used_by UploadContentBlockImage: type: object properties: upload: type: string format: binary required: - upload description: '' UploadTemplateImage: type: object properties: upload: type: string format: binary required: - upload description: '' User: type: object properties: id: type: integer readOnly: true guid: type: string format: uuid readOnly: true description: globally unique identifier for user first_name: type: string readOnly: true last_name: type: string readOnly: true email: type: string format: email readOnly: true timezone: enum: - Pacific/Midway - America/Adak - Pacific/Honolulu - Pacific/Marquesas - America/Anchorage - America/Tijuana - America/Los_Angeles - America/Phoenix - America/Chihuahua - America/Denver - America/Belize - America/Chicago - Pacific/Easter - America/Mexico_City - America/Regina - America/Bogota - America/Cancun - America/New_York - America/Port-au-Prince - America/Havana - America/Indiana/Indianapolis - America/Asuncion - America/Halifax - America/Caracas - America/Cuiaba - America/Manaus - America/Santiago - America/Grand_Turk - America/St_Johns - America/Fortaleza - America/Sao_Paulo - America/Cayenne - America/Buenos_Aires - America/Godthab - America/Montevideo - America/Miquelon - America/Bahia - America/Noronha - Atlantic/Azores - Atlantic/Cape_Verde - UTC - Africa/Casablanca - Europe/London - Africa/Monrovia - Europe/Amsterdam - Europe/Belgrade - Europe/Brussels - Europe/Warsaw - Africa/Algiers - Africa/Windhoek - Asia/Amman - Europe/Athens - Asia/Beirut - Africa/Cairo - Asia/Damascus - Asia/Gaza - Africa/Harare - Europe/Helsinki - Asia/Jerusalem - Europe/Kaliningrad - Africa/Tripoli - Asia/Baghdad - Asia/Istanbul - Asia/Kuwait - Europe/Minsk - Europe/Moscow - Africa/Nairobi - Asia/Tehran - Asia/Muscat - Europe/Astrakhan - Asia/Baku - Europe/Samara - Indian/Mauritius - Asia/Tbilisi - Asia/Yerevan - Asia/Kabul - Asia/Tashkent - Asia/Yekaterinburg - Asia/Karachi - Asia/Kolkata - Asia/Colombo - Asia/Katmandu - Asia/Almaty - Asia/Dhaka - Asia/Rangoon - Asia/Novosibirsk - Asia/Bangkok - Asia/Barnaul - Asia/Hovd - Asia/Krasnoyarsk - Asia/Tomsk - Asia/Chongqing - Asia/Irkutsk - Asia/Kuala_Lumpur - Australia/Perth - Asia/Taipei - Asia/Ulaanbaatar - Asia/Pyongyang - Australia/Eucla - Asia/Chita - Asia/Tokyo - Asia/Seoul - Asia/Yakutsk - Australia/Adelaide - Australia/Darwin - Australia/Brisbane - Australia/Canberra - Pacific/Guam - Australia/Hobart - Asia/Vladivostok - Australia/Lord_Howe - Pacific/Bougainville - Asia/Srednekolymsk - Asia/Magadan - Pacific/Norfolk - Asia/Sakhalin - Pacific/Guadalcanal - Asia/Anadyr - Pacific/Auckland - Pacific/Fiji - Pacific/Chatham - Pacific/Tongatapu - Pacific/Apia - Pacific/Kiritimati type: string readOnly: true locale: type: string readOnly: true nullable: true theme: enum: - light - dark - system type: string readOnly: true g2_verified: type: boolean readOnly: true role: enum: - owner - admin - member type: string readOnly: true is_mfa_enabled: type: boolean readOnly: true required: - email - first_name - g2_verified - guid - id - is_mfa_enabled - last_name - locale - role - theme - timezone description: '' UserPersonalization: type: object properties: ui_version: enum: - 1 - 2 type: integer list_view:templates: $ref: '#/components/schemas/UserPersonalizationListViewTemplate' tp:freshchat:restoreId: type: string format: uuid description: '' UserPersonalizationListViewTemplate: type: object properties: type: enum: - card - template type: string required: - type description: '' ValidationError: type: object properties: errors: type: object additionalProperties: type: array items: type: string non_field_errors: type: array items: type: string required: - errors - non_field_errors description: '' VerifiedEmailDNSAccounts: type: object properties: accounts: type: array items: $ref: '#/components/schemas/DeliveryEmailAccount' description: List of verified email DNS accounts required: - accounts description: '' VerifyEmailAccountOTP: type: object properties: action_name: enum: - verify - update type: string email: type: string format: email nullable: true otp: type: string maxLength: 6 display_name: type: string required: - action_name - otp description: '' WebhookDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true url: type: string maxLength: 255 headers: type: object additionalProperties: {} nullable: true payload: type: object additionalProperties: {} nullable: true required: - id - name - url WordAddInPromptSuggestions: type: object properties: title: type: string writeOnly: true first_page_content: type: string writeOnly: true nullable: true main_headings: type: string writeOnly: true nullable: true prompts: type: array items: type: string readOnly: true required: - prompts - title description: '' WordAddInTemplateEdit: type: object properties: user_input: type: string writeOnly: true content_type: enum: - text - group - table type: string writeOnly: true selected_content: type: string writeOnly: true ai_response: type: string readOnly: true required: - ai_response - content_type - selected_content - user_input description: '' Workspace: type: object properties: id: type: integer readOnly: true org_name: type: string maxLength: 60 unique_key: type: string readOnly: true role: type: string readOnly: true timezone: enum: - Pacific/Midway - America/Adak - Pacific/Honolulu - Pacific/Marquesas - America/Anchorage - America/Tijuana - America/Los_Angeles - America/Phoenix - America/Chihuahua - America/Denver - America/Belize - America/Chicago - Pacific/Easter - America/Mexico_City - America/Regina - America/Bogota - America/Cancun - America/New_York - America/Port-au-Prince - America/Havana - America/Indiana/Indianapolis - America/Asuncion - America/Halifax - America/Caracas - America/Cuiaba - America/Manaus - America/Santiago - America/Grand_Turk - America/St_Johns - America/Fortaleza - America/Sao_Paulo - America/Cayenne - America/Buenos_Aires - America/Godthab - America/Montevideo - America/Miquelon - America/Bahia - America/Noronha - Atlantic/Azores - Atlantic/Cape_Verde - UTC - Africa/Casablanca - Europe/London - Africa/Monrovia - Europe/Amsterdam - Europe/Belgrade - Europe/Brussels - Europe/Warsaw - Africa/Algiers - Africa/Windhoek - Asia/Amman - Europe/Athens - Asia/Beirut - Africa/Cairo - Asia/Damascus - Asia/Gaza - Africa/Harare - Europe/Helsinki - Asia/Jerusalem - Europe/Kaliningrad - Africa/Tripoli - Asia/Baghdad - Asia/Istanbul - Asia/Kuwait - Europe/Minsk - Europe/Moscow - Africa/Nairobi - Asia/Tehran - Asia/Muscat - Europe/Astrakhan - Asia/Baku - Europe/Samara - Indian/Mauritius - Asia/Tbilisi - Asia/Yerevan - Asia/Kabul - Asia/Tashkent - Asia/Yekaterinburg - Asia/Karachi - Asia/Kolkata - Asia/Colombo - Asia/Katmandu - Asia/Almaty - Asia/Dhaka - Asia/Rangoon - Asia/Novosibirsk - Asia/Bangkok - Asia/Barnaul - Asia/Hovd - Asia/Krasnoyarsk - Asia/Tomsk - Asia/Chongqing - Asia/Irkutsk - Asia/Kuala_Lumpur - Australia/Perth - Asia/Taipei - Asia/Ulaanbaatar - Asia/Pyongyang - Australia/Eucla - Asia/Chita - Asia/Tokyo - Asia/Seoul - Asia/Yakutsk - Australia/Adelaide - Australia/Darwin - Australia/Brisbane - Australia/Canberra - Pacific/Guam - Australia/Hobart - Asia/Vladivostok - Australia/Lord_Howe - Pacific/Bougainville - Asia/Srednekolymsk - Asia/Magadan - Pacific/Norfolk - Asia/Sakhalin - Pacific/Guadalcanal - Asia/Anadyr - Pacific/Auckland - Pacific/Fiji - Pacific/Chatham - Pacific/Tongatapu - Pacific/Apia - Pacific/Kiritimati type: string readOnly: true plan_id: type: string nullable: true readOnly: true plan_status: type: string readOnly: true active: type: boolean readOnly: true mfa_enforced: type: boolean readOnly: true created_time: type: string format: date-time readOnly: true required: - active - created_time - id - mfa_enforced - org_name - plan_id - plan_status - role - timezone - unique_key description: '' YouSignDelivery: type: object description: '' properties: id: type: integer readOnly: true failure_email_recipients: type: string nullable: true maxLength: 255 account: type: integer signers: type: array minItems: 1 items: type: object properties: first_name: type: string minLength: 2 last_name: type: string minLength: 2 email: type: string format: email phone_number: type: string locale: type: string minLength: 2 enum: - en - fr - de - it - nl - es - pl success_url: type: string format: uri error_url: type: string format: uri signature_authentication_mode: type: string enum: - otp_email - otp_sms - no_otp signature_level: type: string enum: - electronic_signature - advanced_electronic_signature - electronic_signature_with_qualified_certificate - qualified_electronic_signature_mode_1 order: type: number required: - first_name - last_name - email - locale - signature_level - signature_authentication_mode approvers: type: array items: type: object properties: locale: type: string minLength: 2 enum: - en - fr - de - it - nl - es - pl first_name: type: string minLength: 2 last_name: type: string minLength: 2 email: type: string format: email phone_number: type: string required: - locale - first_name - last_name - email nullable: true followers: type: array items: type: object properties: locale: type: string minLength: 2 enum: - en - fr - de - it - nl - es - pl email: type: string format: email required: - locale - email nullable: true reminder_settings: type: object properties: interval_in_days: type: number enum: - 1 - 2 - 7 - 14 max_occurrences: type: number minimum: 1 maximum: 10 required: - interval_in_days - max_occurrences nullable: true name: type: string maxLength: 255 type: enum: - webhook - azure_blob_storage - box_drive - signature - docu_sign - sign_now - zoho_crm - dropbox - google_drive - podio - one_drive - sharepoint - eversign - hellosign - aws_s3 - signable - yousign - email - sftp type: string success_callback_url: type: string nullable: true maxLength: 255 success_callback_payload: type: object additionalProperties: {} nullable: true success_callback_headers: type: object additionalProperties: {} nullable: true last_used_on: type: string format: date-time nullable: true title: type: string maxLength: 256 email_custom_note: type: string nullable: true delivery_mode: enum: - email type: string ordered_signers: type: boolean timezone: type: string nullable: true maxLength: 100 expiration_date: type: string format: date nullable: true custom_experience_id: type: string nullable: true maxLength: 256 yousign_workspace_id: type: string nullable: true maxLength: 256 audit_trail_locale: type: string nullable: true maxLength: 256 enable_optional_signers: type: boolean required: - account - id - name - signers - title securitySchemes: OAuthAuthentication: type: http scheme: bearer description: OAuth2 Bearer Token Authentication SessionAuthentication: type: apiKey in: cookie name: sessionid description: browser based login takes care of this tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Basic" externalDocs: description: Help docs on how to use API url: https://help.docupilot.app/developers/api-overview