Send an order message or note

Adds a message to the order’s conversation, authored by the token’s user (422 on $.base without one). External messages (default) are visible to the customer; internal: true adds a staff note. notify: true (external only, 422 on $.notify otherwise) also emails the message to the customer after it is saved. The order must have a contact (422 on $.order). Unknown fields answer 422. Needs the full orders.write scope; the _own scopes get 403.

POST/orders/{order_id}/messages

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

order_idstringrequired

Request body

requiredapplication/json

bodystringrequired

min length 1 · max length 5000

internalboolean

default: false

notifyboolean

default: false

Responses

201

Message created

idinteger

bodystring

internalboolean

true for a staff note, hidden from the customer.

senderstring

authorobject | null

Show properties

idinteger

namestring

created_onstring<date-time>

422

Invalid body, unknown field, notify on a note, no user on the token, or order without contact.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

order_idpath*

Bodyapplication/json

bodystring*internalbooleannotifyboolean

Request

curl -X POST 'https://api.onbolder.com/v2/orders/string/messages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "Tu visita quedo agendada para el martes.",
  "notify": true
}'

const response = await fetch("https://api.onbolder.com/v2/orders/string/messages", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"Tu visita quedo agendada para el martes.\",\n  \"notify\": true\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/orders/string/messages",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"body\": \"Tu visita quedo agendada para el martes.\",\n  \"notify\": true\n}",
)

Response

{
  "id": 0,
  "body": "string",
  "internal": true,
  "sender": "admin",
  "author": {
    "id": 0,
    "name": "string"
  },
  "created_on": "2019-08-24T14:15:22Z"
}