Inbox

Create a new inbox message

Changed on

Creates a new inbox message that will appear in the inbox

post/inboxmessage.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/inboxmessage.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: publish_inbox

Request body

subjectstring required

Subject of the message

message_textstring required

Plain text content of the message

from_namestring

Name of the sender

from_emailstring email

Email address of the sender

json_dataobject

Additional data to be used when converting the message to a job

regarding_company_uuidstring uuid

UUID of the company this message is regarding

Response

Message created successfully

uuidstring uuid
activeboolean
edit_datestring date-time
timestampstring date-time
read_timestampstring date-time nullable
last_reply_timestampstring date-time nullable
snooze_until_timestampstring date-time nullable
read_by_staff_uuidstring uuid nullable
from_namestring
from_emailstring
to_emailstring
subjectstring
message_textstring
message_htmlstring
is_archivedboolean
archived_timestampstring date-time nullable
archived_by_staff_uuidstring uuid nullable
regarding_company_uuidstring uuid nullable
converted_to_job_uuidstring uuid nullable
job_template_uuidstring uuid nullable
message_type'email' | 'sms' | 'online_booking' | 'phone_call' | 'reminder' | 'form' | 'network_request' | 'supplier_invoice' | 'asset' | 'partner_lead' | 'automation'

Changes