messages

complete a message

Complete a message.

post/messages/{parentMessageId}/complete

Request

  • Base URL: https://efcms-dev.ustc-case-mgmt.flexion.us
  • URL: https://efcms-dev.ustc-case-mgmt.flexion.us/messages/{parentMessageId}/complete
  • Auth: API key in header Authorization

Response

200 response

caseStatusstring

status of the associated case

caseTitlestring

case title for the associated cases

completedAtstring

when the message was marked as completed

completedBystring

the name of the user who completed the message thread

completedBySectionstring

the section of the user who completed the message thread

completedByUserIdstring

the ID of the user who completed the message thread

completedMessagestring

the message entered when completing the message thread

createdAtstring

message created time

docketNumberstring

docket number of the associated case

docketNumberWithSuffixstring

docket number of the associated case with its suffix

entityNamestring

the name of the entity - Message

fromstring

the name of the user who sent the message

fromSectionstring

the section of the user who sent the message

fromUserIdstring

the ID of the user who sent the message

isCompletedboolean

whether the message thread has been completed

isRepliedToboolean

whether the message has been replied to or forwarded

messagestring

the message text

messageIdstring

the unique ID generated by the system to represent the message

parentMessageIdstring

the unique ID generated by the system to represent the parent / initial message

subjectstring

the subject line of the message

tostring

the name of the user who is the recipient of the message

toSectionstring

the section of the user who is the recipient of the message

toUserIdstring

the ID of the user who is the recipient of the message

Changes

No recorded changes to this operation across all 55 revisions of this API.