Instances

Notify participants

Sends SMS or e-mail notification with custom message to the participants. Notifications can be sent only for in progress instances.

post/experimental/flow/instances/{instance_id}/notify_participants

Request

Base URL
https://scrive.com
Auth
- HTTP oauth1
- or OAuth 2
  Authorization code/oauth2/auth
  Token URL/oauth2/token
  Scopesfull
- or API key in cookie sessionId and API key in header X-Scrive-XToken
TypeScript
https://skmtc.dev/scrive/apis/scrive-flow-api/docs/experimental/flow/instances/:instance_id/notify_participants/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

instance_idstring uuid required

Unique identifier of the requested instance.

Request body

participant_idstring uuid required

Unique identifier of the participant.

method'email' | 'sms' required

Notification method

language'sv' | 'en' | 'de' | 'fr' | 'it' | 'es' | 'pt' | 'nl' | 'da' | 'no' | 'el' | 'fi' | 'is' | 'et' | 'lv' | 'lt' | 'cs' | 'pl' | 'hu'

messagestring required

Custom message text for a notification.

Example request

[
  {
    "language": "en",
    "message": "e-mail message",
    "method": "email",
    "participant_id": "78b4265b-e96e-4172-97b8-1144f6e71729"
  }
]

Changes

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