---
title: "Notify participants"
method: POST
path: "/experimental/flow/instances/{instance_id}/notify_participants"
tags: ["Instances"]
---

# Notify participants

`POST /experimental/flow/instances/{instance_id}/notify_participants`

## Request

- Base URL: `https://scrive.com`
- URL: `https://scrive.com/experimental/flow/instances/{instance_id}/notify_participants`
- Auth: one of:
  - HTTP oauth1
  - OAuth 2
    - Authorization code: `/oauth2/auth`
    - Token URL: `/oauth2/token` scopes: `full`
  - 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)

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

## Path parameters

- `instance_id` string, uuid, required: Unique identifier of the requested instance.

## Request body

- EventNotifyParticipant[]
  - `participant_id` string, 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'
  - `message` string, required: Custom message text for a notification.

## Response `204`

## Other responses

- `400`: Invalid `body`
- `404`: `instance_id` not found

---

[API](https://skmtc.dev/scrive/apis/scrive-flow-api.md) - [All operations](https://skmtc.dev/scrive/apis/scrive-flow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrive/apis/scrive-flow-api/revisions/f9b2836863f2?raw)