Plan a notification for a message

POST /chat/messages/{id}/plan-notification

Bearer token

Plan a notification for a message (so the legacy cron system can send it)

Path parameters

id integer Required

The message id

application/json

Body

id_ambassador_target integer Required

Responses

200 application/json

Return the created notification
Hide response attribute Show response attribute object
- message string
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

POST /chat/messages/{id}/plan-notification

curl \
 -X POST https://domain.tld/api/v2/chat/messages/{id}/plan-notification \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"id_ambassador_target":5}'

Request examples

{
  "id_ambassador_target": 5
}

Response examples (200)

{
  "message": "Notification planned successfully"
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}