Cancel doc group invite

This endpoint allows API users to cancel a document group invite. All documents will be unshared with invitees. Any signatures that occurred before canceling will remain on the documents.

post/documentgroup/{document_group_id}/groupinvite/{invite_id}/cancelinvite

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/documentgroup/:document_group_id/groupinvite/:invite_id/cancelinvite/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ID of the document group.

ID of the document group invite.

Request body

reasonstring

Reason for canceling the invite. Included in the cancellation email to signers. Max: 1000 characters. Emoji and other 4-byte characters aren't supported.

notify_usersboolean

If true, signers get a cancellation email and SMS. Set to false to cancel the invite without notifying them. Default: true.

Response

The document group invite was cancelled.

statusstring

Result of the request. Always success.

Changes

No recorded changes to this operation across all 1 revision of this API.