Update Message¶

PUT https://api.speakap.io/networks/:eid/messages/:eid/

Use cases¶

Change the title and/or body text of a message
Turn on/off the possibility to comment on a message

Request

URI:	/networks/{networkEID}/messages/{messageEID}/
Method:	PUT
Content-Type:	application/json
Authentication:	OAuth 2.0

Parameters¶

Name	Type	Description
networkEID	EID	Network EID
messageEID	EID	Message EID

Request body¶

Supply a complete message resource in the request body possibly supplemented with a recipient or parent object. You should omit the created date as it will be set server-side. The author relation will be automatically set to the logged in user.

Name	Type	Description
recipient	object	Message recipient
recipient EID	EID	Unique entity identifier
recipient type	string	Message type
parent	object	Parent message in case of a comment
parent EID	EID	Unique entity identifier
parent type	string	Message type

Example¶

{
    "messageType": "comment",
    "body": "I don't always comment on updates, but when I do it ends up in an example",
    "parent": {
        "EID": "1234567890ABCDEF",
        "type": "update"
    }
}

Response

Status code:

202: Accepted for storage: returns a Feedback object

400: Invalid data: returns an Error object

403: Unauthorized: returns an Error object

404: Unknown message or network: returns an Error object

409: Conflict: returns an Error object

410: Deleted message: returns an Error object