Bundeling

Messages

Messages can be sent from one user to another and can either be a normal message or a connection invite. For privacy reasons, user authentication is always required for this endpoint.

list

Retrieves all messages for the current user.

single

Retrieves a single message.

create

Sends a new message or connection invite.

update

Updates the status of a message or connection invite. Can only be changed by the recipient. Accepting an invitation will create a connection between the author and the recipient of the message.

delete

Deletes a single message or invitation.

Json

XML

POST https://api.bundeling.com/V2/messages

Parameters

Body

Name	Description	Type	Nillable	Required
`recipient_uuid`	The unique identifier of the receiving user.	`string`	`false`	`true`
`type`	Defines if it is a message, or a user connection invitation. Accepted values: `message, invite`	`string`	`false`	`true`
`colleague_user_uuid`	When 2 users are already connected, they can introduce colleagues to each other by sending an "invite" with the unique identifier of the user to introduce in this field.	`string`	`false`	`false`
`object_type`	The message can be linked to an other object Accepted values: `bulletin_board_item, connection`	`string`	`false`	`false`
`object_uuid`	The unique identifier from the linked object	`string`	`false`	`false`
`message`	The actual body of the message.	`string`	`false`	`true`

Example request

Choose language

Headers

Body

{
    "recipient_uuid": "8e09c4749b234633a7319148aac8cb81",
    "type": "message",
    "colleague_user_uuid": "48b99d307f8746a8b126f76be5d1153e",
    "object_type": "bulletin_board_item",
    "object_uuid": "d669b048d2084892b5a5232b78923227",
    "message": "Dear John Doe..."
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "author_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "recipient_uuid": "8e09c4749b234633a7319148aac8cb81",
    "type": "message",
    "colleague_user_uuid": "48b99d307f8746a8b126f76be5d1153e",
    "object_type": "",
    "object_uuid": "",
    "file_uuid": "",
    "status": "read",
    "message": "Dear John Doe...",
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}