MOmonta
Users

Send the welcome email to users

Changed on

Sends the welcome email to up to 100 of your users, so you can choose when they receive it. Each user is processed independently and gets its own result. A user who already got the welcome email is skipped, so a repeated or retried call never sends it twice; set force to send it again. Users that are not yours or have no email fail without affecting the others. Required scope: users:write </br>Organization authorization: supported

post/api/v1/users/welcome-email

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/users/welcome-email
  • Auth
    HTTP bearer

Request body

forceboolean

Send again to users who already got the welcome email. By default they are skipped, so repeating a call is safe

Example request

{
  "items": [
    {
      "userId": 12345
    }
  ]
}

Response

Result per requested user

Example response

{
  "data": [
    {
      "userId": 12345,
      "error": "USER_NOT_FOUND"
    }
  ],
  "meta": {
    "successCount": 2
  }
}

Changes