Message

Message Service

Web service endpoints for messages that are replies in a discussion.

Create Content Message

POST /messages/contents/{contentID}

Create a new message with the specified characteristics as a direct reply to the specified content object, which must be a discussion.

Path Parameters:
NameTypeRequiredDescription
contentIDStringtrueID of the content object (must be a discussion) for which to create a reply
Query Parameters:
NameTypeRequiredDescription
publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
fieldsStringfalseFields to include in the returned Message
Takes:
  • Message describing the entity to be created
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent content object cannot be found

    Upload New Content Message

    POST /messages/contents/{contentID}

    Create a new message with the specified characteristics as a direct reply to the specified content object, which must be a discussion. Uploaded files will be added to the message as attachments.

    Path Parameters:
    NameTypeRequiredDescription
    contentIDStringtrueID of the content object (must be a discussion) for which to create a reply
    Query Parameters:
    NameTypeRequiredDescription
    publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
    updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
    fieldsStringfalseFields to include in the returned Message
    Takes:
  • Multipart of subtype form-data that will include a section with a Message describing the entity to be created and another section for each file being uploaded.
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent content object cannot be found

    Create Extended Properties

    POST /messages/{messageID}/extprops

    Save a new set of extended properties for a message, and return an entity representing the newly created extended properties. Any previous extended properties for this comment will be completely replaced.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being created on the target message will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to create extended properties
    Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is malformed or max number of extended properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for this message
    404 (Not Found)The specified comment does not exist

    Create Extended Properties For Addon

    POST /messages/{messageID}/extprops/addOn/{addonUUID}

    Save a new set of extended properties for a message, and return an entity representing the newly created extended properties. Any previous extended properties for this comment will be completely replaced.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to create extended properties
    addonUUIDStringtrueUUID of the addon for which the properties are created.
    Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is malformed or max number of extended properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for this message
    404 (Not Found)The specified comment does not exist
    Since: 3.9

    Create Message

    POST /messages

    Create a new message with the specified characteristics. The parent field must contain the URI of either a discussion for which this is a direct reply, or the URI of a previous message to which this is a reply.

    Query Parameters:
    NameTypeRequiredDescription
    publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
    updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
    fieldsStringfalseFields to include in the returned Message
    Takes:
  • Message describing the entity to be created
    • Retrieves:
  • Message describing the newly created message
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent content object cannot be found

    Upload New Message

    POST /messages

    Create a new message with the specified characteristics. The parent field must contain the URI of either a discussion for which this is a direct reply, or the URI of a previous message to which this is a reply. Uploaded files will be added to the message as attachments.

    Query Parameters:
    NameTypeRequiredDescription
    publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
    updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
    fieldsStringfalseFields to include in the returned Message
    Takes:
  • Multipart of subtype form-data that will include a section with a Message describing the entity to be created and another section for each file being uploaded.
    • Retrieves:
  • Message describing the newly created message
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent content object cannot be found

    Create Message Helpful

    POST /messages/{messageID}/helpful

    Register that the requesting person considers the specified message helpful.

    Note: If this is the first time the specified content has been marked helpful a helpful outcome will be created

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be marked as helpful
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this message or mark this message as helpful
    404 (Not Found)The specified message does not exist

    Create Message Like

    POST /messages/{messageID}/likes

    Register that the requesting person likes the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be liked
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access or like this message
    404 (Not Found)The specified message does not exist

    Create Message Unhelpful

    POST /messages/{messageID}/unhelpful

    Register that the requesting person considers the specified message unhelpful.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be marked as unhelpful
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this message or mark this message as unhelpful
    404 (Not Found)The specified message does not exist

    Create Outcome

    POST /messages/{messageID}/outcomes
    Create the outcome on the specified message
    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the comment for which to create the outcome
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned on the new outcome
    Takes:
  • the outcome to create
    • Retrieves:
  • Outcome describing the new create outcome on that message
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)Ad outcome of this type already exists on the message
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Create Reply

    POST /messages/{messageID}/messages

    Create a new message as a reply to an existing message with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message being replied to
    Query Parameters:
    NameTypeRequiredDescription
    publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
    updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
    fieldsStringfalseFields to include in the returned Message
    Takes:
  • Message describing the reply message to be created
    • Retrieves:
  • Message describing the new reply message
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)If an input field is missing or malformed
    409 (Conflict)if you attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)if you are not allowed to perform this operation
    404 (Not Found)if the specified parent content object (or comment) cannot be found

    Upload New Reply

    POST /messages/{messageID}/messages

    Create a new message as a reply to an existing message with the specified characteristics. Uploaded files will be added to the message as attachments.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message being replied to
    Query Parameters:
    NameTypeRequiredDescription
    publishedStringfalseDate and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
    updatedStringfalseDate and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
    fieldsStringfalseFields to include in the returned Message
    Takes:
  • Multipart of subtype form-data that will include a section with a Message describing the reply message to be created and another section for each file being uploaded.
    • Retrieves:
  • Message describing the new reply message
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent content object (or comment) cannot be found

    Destroy Extended Properties

    DELETE /messages/{messageID}/extprops

    Delete the existing extended properties for the specified message.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being deleted on the target message will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which the extended properties are to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field was malformed
    403 (Forbidden)You are not allowed to delete extended properties
    404 (Not Found)The specified message does not exist

    Destroy Extended Properties For Addon

    DELETE /messages/{messageID}/extprops/addOn/{addonUUID}

    Delete the existing extended properties for the specified message.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    addonUUIDStringtrueUUID of the addon for which the properties are deleted.
    messageIDStringtrueID of the message for which the extended properties are to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field was malformed
    403 (Forbidden)You are not allowed to delete extended properties
    404 (Not Found)The specified message does not exist
    Since: 3.9

    Destroy Message

    DELETE /messages/{messageID}

    Delete the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified message
    404 (Not Found)The specified message does not exist

    Destroy Message Helpful

    DELETE /messages/{messageID}/helpful

    Delete the registration of the specified message as helpful by the requesting user.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which a helpful registration is being removed
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    409 (Conflict)You do not currently have a helpful mark registered for this message
    403 (Forbidden)You are not allowed to access this message or unregister this message as helpful
    404 (Not Found)The specified message does not exist

    Destroy Message Like

    DELETE /messages/{messageID}/likes

    Delete the like of the specified message by the requesting user.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which a like is being removed
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    409 (Conflict)You do not currently have a like registered for this message
    403 (Forbidden)You are not allowed to access or unlike this message
    404 (Not Found)The specified message does not exist

    Destroy Message Unhelpful

    DELETE /messages/{messageID}/unhelpful

    Delete the registration of the specified message as unhelpful by the requesting user.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which an unhelpful registration is being removed
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    409 (Conflict)You do not currently have an unhelpful mark registered for this message
    403 (Forbidden)You are not allowed to access this message or remove the registration of this message as unhelpful
    404 (Not Found)The specified message does not exist

    Get Content Replies

    GET /messages/contents/{contentID}

    Return a paginated list of messages for the specified content object, which must be a discussion, optionally limiting the results to direct replies only.

    Path Parameters:
    NameTypeRequiredDescription
    contentIDStringtrueID of the content object (must be a discussion) for which to return reply messages
    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseThe filter criteria used to select reply messages
    excludeRepliesBooleanfalseFlag indicating whether to exclude replies (and therefore return direct replies only) (default is false)
    hierarchicalBooleanfalseFlag indicating that replies should be returned in hierarchical order instead of chronological order. (default is true) Since v3.1
    startIndexIntegerfalseZero-relative index of the first message to be returned (default is 0)
    countIntegerfalseMaximum number of messages to be returned (default is 25)
    anchorStringfalseoptional URI for a message to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of messages will be returned.
    fieldsStringfalseFields to be returned in the selected messages
    Retrieves:
  • Message[] containing the requested messages
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified content object or its messages
    404 (Not Found)The specified content object does not exist

    Get Editable Message

    GET /messages/{messageID}/editable

    Return the specified editable message with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • Message containing the specified editable message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)if content is already being edited by another user
    403 (Forbidden)You are not allowed to access the specified comment
    404 (Not Found)The specified comment does not exist

    Get Extended Properties

    GET /messages/{messageID}/extprops

    Return the extended properties for the specified message.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being fetched from the target message will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return extended properties
    Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field was malformed
    403 (Forbidden)You are not allowed to retrieve extended properties
    404 (Not Found)Specified message does not exist

    Get Extended Properties For Addon

    GET /messages/{messageID}/extprops/addOn/{addonUUID}

    Return the extended properties for the specified message.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return extended properties
    addonUUIDStringtrueUUID of the addon for which the properties are fetched.
    Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field was malformed
    403 (Forbidden)You are not allowed to retrieve extended properties
    404 (Not Found)Specified message does not exist
    Since: 3.9

    Get Have Marked Helpful

    GET /messages/{messageID}/helpful

    Return a paginated list of the people who consider this message helpful.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message that has been marked helpful
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first person to be returned (default is 0)
    countIntegerfalseMaximum number of people to be returned (default is 25)
    fieldsStringfalseFields to be returned on people who have marked this message as helpful (default is @summary)
    Retrieves:
  • Person[] listing people who also have marked this message helpful
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Get Have Marked Unhelpful

    GET /messages/{messageID}/unhelpful

    Return a paginated list of the people who consider this message unhelpful.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message that has been marked unhelpful
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first person to be returned (default is 0)
    countIntegerfalseMaximum number of people to be returned (default is 25)
    fieldsStringfalseFields to be returned on people who have marked this message as unhelpful (default is @summary)
    Retrieves:
  • Person[] listing people who also have marked this message unhelpful
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Get Message

    GET /messages/{messageID}

    Return the specified message with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    abridgedBooleanfalseFlag indicating that if content.text is requested, it will be abridged (length shortened, HTML tags removed)
    Retrieves:
  • Message containing the specified message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified comment
    404 (Not Found)The specified comment does not exist

    Get Message Likes

    GET /messages/{messageID}/likes

    Return a paginated list of the people who like the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return liking people
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first person to be returned (default is 0)
    countIntegerfalseMaximum number of people to be returned (default is 25)
    fieldsStringfalseFields to be returned on liking people (default is @summary)
    Retrieves:
  • Person[] listing people who like this message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Get Outcomes

    GET /messages/{messageID}/outcomes

    Return a paginated list of the outcomes for the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return the outcomes for
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first outcome type to be returned
    countIntegerfalseMaximum number of outcomes to be returned
    fieldsStringfalseFields to be returned on outcomes
    Retrieves:
  • Outcome[] listing the outcomes who like the specified comment
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Get Outcome Types

    GET /messages/{messageID}/outcomeTypes

    Return a paginated list of the possible outcome types for the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return possible outcome types
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first outcome type to be returned
    countIntegerfalseMaximum number of outcome types to be returned
    fieldsStringfalseFields to be returned on OutcomeTypeEntity outcome types
    Retrieves:
  • OutcomeType[] listing the outcome types possible to specify on the message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Get Replies

    GET /messages/{messageID}/messages

    Return a paginated list of messages that are replies to the specified message, optionally limiting the returned results to direct replies only.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message for which to return reply messages
    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseThe filter criteria used to select messages
    excludeRepliesBooleanfalseFlag indicating whether to exclude replies (and therefore return direct replies only) (default is false)
    hierarchicalBooleanfalseFlag indicating that returned replies should be sorted hierarchically (true) or chronologically (false)
    startIndexIntegerfalseZero-relative index of the first message to be returned (default is 0)
    countIntegerfalseMaximum number of messages to be returned (default is 25)
    anchorStringfalseoptional URI for a message to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of messages will be returned.
    messageTargetStringfalseis the target from which you want to replies. Must be one of "replyToTlo", "replyAsComment", "all"
    fieldsStringfalseFields to be returned in the selected messages
    Retrieves:
  • Message[] listing replies to the specified message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified message or its replies
    404 (Not Found)The specified message does not exist

    Lock Editable Message

    POST /messages/{messageID}/editable

    Attempt to lock the specified message for editing. This method will not fail if the message is already locked. Check the 'editingBy' field in returned entity to see who owns the lock.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be locked
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field was malformed
    409 (Conflict)if content is already being edited by another user
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Update Correct

    PUT /messages/{messageID}/correctAnswer

    Mark the specified message correct.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be marked correct
    Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)BadRequestException
    403 (Forbidden)ForbiddenException
    404 (Not Found)NotFoundException

    Lock Editable Message

    DELETE /messages/{messageID}/editable

    Unlock the specified message.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be unlocked
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field was malformed
    403 (Forbidden)You are not allowed to access this message
    404 (Not Found)The specified message does not exist

    Destroy Correct

    DELETE /messages/{messageID}/correctAnswer

    Unmark the specified message correct.

    Takes:
  • messageID
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)BadRequestException
    403 (Forbidden)ForbiddenException
    404 (Not Found)NotFoundException

    Update Editable Message

    PUT /messages/{messageID}/editable

    Update the specified editable message with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    updatedStringfalseDate and time when this content object was most recently updated.
    Takes:
  • Message containing the updated message
    • Retrieves:
  • Message representing the updated editable message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to access the specified message
    404 (Not Found)The specified comment does not exist

    Upload Update Editable Message

    PUT /messages/{messageID}/editable

    Update the specified message with the specified characteristics including the option to replace existing attachments with the ones uploaded in the request.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    updatedStringfalseDate and time when this content object was most recently updated.
    Takes:
  • Multipart of subtype form-data that will include a section with a Message containing the updated message and another section for each file being uploaded.
    • Retrieves:
  • Message representing the updated editable message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to access the specified message
    404 (Not Found)The specified comment does not exist

    Update Message

    PUT /messages/{messageID}

    Update the specified message with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    updatedStringfalseDate and time when this content object was most recently updated.
    Takes:
  • Message containing the updated message
    • Retrieves:
  • Message representing the updated message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to access the specified message
    404 (Not Found)The specified comment does not exist

    Upload Update Message

    PUT /messages/{messageID}

    Update the specified message with the specified characteristics including the option to replace existing attachments with the ones uploaded in the request.

    Path Parameters:
    NameTypeRequiredDescription
    messageIDStringtrueID of the message to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    updatedStringfalseDate and time when this content object was most recently updated.
    Takes:
  • Multipart of subtype form-data that will include a section with a Message containing the updated message and another section for each file being uploaded.
    • Retrieves:
  • Message representing the updated message
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a message to a content object that does not support them, or for which replies have been closed
    403 (Forbidden)You are not allowed to access the specified message
    404 (Not Found)The specified comment does not exist