1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk REST Web Services Records Guide
  4. REST Web Services Supported Records
  5. Message

Message

A message record exposes a message to REST web services.

This record has the following subrecords:

The REST API Browser includes information about the field names and field types of the message record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s message reference page.

For information about using the REST API Browser, see The REST API Browser.

Record ID

The record ID for the message REST record is Message.

Exposed Elements

The following message record elements are exposed to REST web services:

  • activity

  • author

  • authoremail

  • bcc

  • cc

  • emailed

  • entity

  • externalid

  • hasattachment

  • htmlmessage

  • id

  • incoming

  • lastmodifieddate

  • message

  • messagedate

  • recipient

  • recipientemail

  • record

  • recordtype

  • subject

  • template

  • time

  • transaction

Usage Notes

All fields are read-only.

Code Sample

In the following example, <accountID> represents your account ID.

HTTP request: https://<accountID>/services/rest/record/v1/message

Request Body

              { "subject": "Meeting agenda", "message": "Please send the agenda for tomorrow's meeting.", "author": "-5", "authorEmail": "[email protected]", "recipientEmail": "[email protected]", "cc": "[email protected]", "bcc": "[email protected]"
}

To Obtain Previously-Created Message Record (where ID is 230)

HTTP Method: GET

URL: https://<accountID>/services/rest/record/v1/message/230

Response Body

              { "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/message/230 } ], "author": { "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/customer/-5 } ], "id": "-5", "refName": "A Wolfe-admin" }, "authorEmail": "[email protected]", "bcc": "[email protected]", "cc": "[email protected]", "emailed": true, "hasAttachment": false, "htmlMessage": true, "htmlMessage": true, "id": "230", "incoming": true, "lastModifiedDate": "2020-11-25T16:32:00Z", "message": "Please send the agenda for tomorrow's meeting.", "messageDate": "2020-11-25", "recipient": { "links": [ { "rel": "self", "href": "<accountID>/services/rest/record/v1/customer/-5" } ], "id": "-5", "refName": "A Wolfe-admin" }, "recipientEmail": "[email protected]", "subject": "Meeting agenda", "time": "08:32"
}

Related Topics

General Notices