Download OpenAPI specification:Download
The chat service manages chatrooms for our mobile messenger app.
organization_id required | integer id of an organization the chatroom belongs to |
event_id required | integer id of an organization the chatroom belongs to |
{- "assignedUsers": [
- 0
], - "avatarURL": "string",
- "eventID": 0,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledDeletion": null,
- "type": "string"
}
organization_id | integer optional organization id, returns all chatrooms for the organization if set |
all | boolean Default: false returns all entries, ignoring limit and offset parameters |
limit | integer [ 1 .. 50 ] Default: 10 max. amount of chatrooms in paginated list |
offset | integer Default: 0 skipped chatrooms in paginated list |
{- "entries": [
- {
- "assignedUsers": [
- 0
], - "avatarURL": "string",
- "eventID": 0,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledDeletion": null,
- "type": "string"
}
], - "total": 0
}
assignedUsers | Array of integers <int64> [ items <int64 > ] |
name | string |
organizationID | integer <int64> |
{- "assignedUsers": [
- 0
], - "name": "string",
- "organizationID": 0
}
{- "assignedUsers": [
- 0
], - "avatarURL": "string",
- "eventID": 0,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledDeletion": null,
- "type": "string"
}
organizationID required | integer id of the organization |
{- "assignedUsers": [
- 0
], - "avatarURL": "string",
- "eventID": 0,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledDeletion": null,
- "type": "string"
}
roomID required | integer unique identifier of the chatroom |
{- "assignedUsers": [
- 0
], - "avatarURL": "string",
- "eventID": 0,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledDeletion": null,
- "type": "string"
}
roomID required | integer unique identifier of the chatroom |
assignedUsers | Array of integers <int64> [ items <int64 > ] |
name | string |
organizationID | integer <int64> |
{- "assignedUsers": [
- 0
], - "name": "string",
- "organizationID": 0
}
Send an empty body to remove the avatar.
roomID required | integer unique identifier of the chatroom |
"string"