notification

Send a email or in-app notification

post/v1/org/{orgId}/notification

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/notification
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

templateNamestring required

name of message template

toUserIdsstring[] required

user ids for users to be notified

atsNamestring

name of the ATS system

orgNamestring

name of the organization

userNamestring

preferred name of the user

syncSummarystring

summary of reason for email

processIdstring

id of the sync history process

Example request

{
  "toUserIds": [
    "588f7ee98f138b19220041a7"
  ],
  "jobData": {
    "jobId": "588f7ee98f138b19220041a7"
  },
  "processId": "588f7ee98f138b19220041a7"
}

Response

notification sent

Changes

No recorded changes to this operation across all 20 revisions of this API.