Create invitation

Authorization

basicAuth

AuthorizationBasic <token>

In: header

Path Parameters

organizationId*string

signingRoomId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

callbackUrl?string

Endpoint URL listening to the callback sent by the system once the user has joined the signing room

Formaturl

email*string

Email of the recipient of the invitation

locale?string

Locale that will be used to send the notification. Must be the two letters ISO 639-1 code. The fallback locale in case the provided value is not supported is 'en'.

manager?boolean

Deprecated

Specify whether the recipient should have the manager permissions in the signing room

signingRoomPermission?string

Specify signing room permission for the signing room

Value in

"SIGNATORY"
"ASSISTANT"
"MANAGER"

skipNotification?boolean

Skip email notification sent to the recipient

Defaultfalse

Response Body

`application/json`

Callbacks

curl -X POST "https://example.com/admin/api/v3/organizations/string/rooms/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'

{  "createdAt": "2019-08-24T14:15:22Z",  "email": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "id": "string",  "locale": "string",  "manager": true,  "signingRoomPermission": "SIGNATORY"}

Create invitation

Authorization

Path Parameters

Request Body

Response Body

201application/json

204application/json

401

403

404

409

Callbacks

invitationAcceptedPOST{$request.body#/callbackUrl}

`application/json`

`application/json`