Fleep

FREE
By raygorodskij
Updated 10 months ago
Communication
-/10
Popularity
-
Latency
-
Success Rate

Fleep API Overview

Founded by ex-Skypers, Fleep is a messenger for your teams and projects. We take email’s ability to contact anyone and marry it with real-time messaging flow.

Contact API Provider
star-blueRate

Fleep

Fleep Package

Founded by ex-Skypers, Fleep is a messenger for your teams and projects. We take email’s ability to contact anyone and marry it with real-time messaging flow.

  • Domain: fleep.io
  • Credentials: username, password

How to get credentials:

  1. Register on the fleep.io

  2. Use username and password for getting ticket and tokenId in loginAccount endpoint

    Custom datatypes:

    Datatype Description Example
    Datepicker String which includes date and time 2016-05-28 00:00:00
    Map String which includes latitude and longitude coma separated 50.37, 26.56
    List Simple array ["123", "sample"]
    Select String with predefined values sample
    Array Array of objects [{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Fleep.loginAccount

Handle user login business logic. If login is successful, it sets session token and returns account info.

Field Type Description
email credentials User email.
password credentials User password.
rememberMe Select Whether user wants long-term session cookie.

Fleep.logoutAccount

Close session.

Field Type Description
ticket String Must be sent as parameter to all subsequent api calls.
tokenId String Token id from loginAccount endpoint.

Fleep.createAccount

Create new account and send verification email.

Field Type Description
email String User email.
password String Initial password to set.
displayName String Name to be displayed in conversations.
referer String Page that referred used to fleep.
useCode Select Use flow based on registration code.

Fleep.repeatEmailCode

Trigger registration code email.

Field Type Description
email String User email.
referer String Page that referred used to fleep.
ticket String Must be sent as parameter to all subsequent api calls.
tokenId String Token id from loginAccount endpoint.

Fleep.sendResetPasswordLink

Request password reset email for active account. Password is not reset yet just email with rest token is sent out. User must click on link in email and then enter new passord to rest it.

Field Type Description
email String User email.
ticket String Must be sent as parameter to all subsequent api calls.
tokenId String Token id from loginAccount endpoint.

Fleep.addReminder

Informs backend that given reminder has been show to the user.

Field Type Description
reminderId String Reminder id.
ticket String Must be sent as parameter to all subsequent api calls.
tokenId String Token id from loginAccount endpoint.

Fleep.getClassificators

Get list of classificators.

Field Type Description
ticket String Must be sent as parameter to all subsequent api calls.
tokenId String Token id from loginAccount endpoint.

Response

mkaccountstatus:
```Describes the state of the account.

new - email has been registered but is goodness is unknown
active - user has stored a password and can participate
banned - user has been banned for some unacceptable activity
closed - user has requested this account to be closed

mk_message_type:

Different messages that may come up in our message flow

text - text message written by user
email - message send over email
separator - taskboard separator
create - conversation created.
add - listed members were added to the conversation. Message: members =
leave - when member left the conversation
kick - when member is removed from conversation
topic - when someone changed conversation topic. Message: topic =
alerts - alert level (never, default)
disclose - user disclosed previous content to members
hook - user created hook for the conversation
unhook - user dropped hook from the conversation
addteam - new team added to the conversation kickteam - team removed from the conversation
hangout - hangout video call was created
separator - taskboard separator
replace - member replcaced email with alternate email
share - auto join url was enabled for conversation
unshare - auto join url was disabled for conversation
autojoin - member used auto join url to join
delfile - obsolete file delete message

mk_alert_level:

Alerting level for conversation.

never - do not alert for this conversation
default - default behaviour

mk_email_interval:

Notification emails for the user.

default - default behaviour is email participation
daily - email notifications only
never - no emails at all ever

## Fleep.editAccountSettings
Change account related settings.

| Field               | Type  | Description
|---------------------|-------|----------
| ticket              | String| Must be sent as parameter to all subsequent api calls.
| tokenId             | String| Token id from loginAccount endpoint.
| displayName         | String| Name displayed instead of email in chats.
| password            | String| New password.
| oldPassword         | String| Required when submitting new password.
| phoneNumber         | String| User's phone number.
| emailInterval       | String| Email interval.
| isFullPrivacy       | Select| Stop sending out reading writing activity.
| isNewsletterDisabled| Select| Enable/disable newsletter sending
| isAutomuteEnabled   | Select| Enable/disable incoming email automute.
| clientSettings      | JSON  | Json encoded dict of changed client settings.
| primaryEmail        | String| Set new primary email (it has to be confirmed as alias first).
| fleepAddress        | String| Set fleep address (results in error if account already has one).

## Fleep.confirmAccount
Confirm receiving email with confirmation code and activate account.

| Field         | Type  | Description
|---------------|-------|----------
| notificationId| String| notification token
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.

## Fleep.confirmAndConfigureAccount
Confirm receiving email and configure account.

| Field         | Type  | Description
|---------------|-------|----------
| notificationId| String| notification token
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| displayName   | String| Display name.
| password      | String| User password.
| fleepAddress  | String| Fleep address.

## Fleep.exportConversationHistory
Export conversation history. User is notified when files are available for download.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| exportAction  | String| What to export: history_all - conversation history, all file types.
| conversationId| String| If set, generate files for this conversation only,and return ConvInfo else return ContactInfo.

## Fleep.getExternalAccountInfo
Get External Account Info.

| Field                | Type  | Description
|----------------------|-------|----------
| ticket               | String| Must be sent as parameter to all subsequent api calls.
| tokenId              | String| Token id from loginAccount endpoint.
| mkExternalAccountType| Select| Type of the connected external account.
| mkPermissionType     | Select| Type of permissions that external account has granted to Fleep.

## Fleep.getContactsRecordList
Lookup accounts.

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| lookupList| List  | List of lookup strings.
| ignoreList| List  | List of accountId's to ignore.

## Fleep.getNotificationIdForFurtherRequests
Get notificationId for further requests.

| Field           | Type  | Description
|-----------------|-------|----------
| ticket          | String| Must be sent as parameter to all subsequent api calls.
| tokenId         | String| Token id from loginAccount endpoint.
| notificationId  | String| Notification id.
| registrationCode| String| Registration code.
| registrationMail| String| Registration mail.

## Fleep.setAccountFlag
Set flag for given account that may be used by clients to display or hide content etc.

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| clientFlag| String| Name of the flag to set or clear.
| boolValue | String| Clear given flag from account.

## Fleep.synchronizehronizePinboard
Synchronize pinboard.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Conversation id.
| pinWeight     | String| Pin weight.
| pinLimit      | Number| Pin limit.

## Fleep.synchronizeTaskboard
Synchronize taskboard.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Conversation id.
| sectionId     | String| Section id.
| taskWeight    | String| Task weight from cursor if provided.
| taskLimit     | Number| Tasks to synchronize in one batch (between 1 and 100).

## Fleep.getTrelloBoardList
Get Trello board list.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| externalAccountId| String| Id of the external account (see ExternalAccountInfo).
| mkPermissionType | Select| Type of permissions that external account has granted to Fleep.

## Fleep.unsubscribeForNotification
Unsubscribe for notification.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| notificationId| String| Id of notification.

## Fleep.deleteCurrentAvatar
Delete current avatar.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.

## Fleep.uploadAvatar
Upload avatar.

| Field    | Type  | Description
|----------|-------|----------
| ticket   | String| Must be sent as parameter to all subsequent api calls.
| tokenId  | String| Token id from loginAccount endpoint.
| imageFile| String| Image for avatar.
| contentType| String| Content-Type of the image.Example - image/jpg.
| imageName| String| Name of the image.

## Fleep.listenForNotificationsFromFleep
Use long poll to listen for notifications from Fleep.

| Field       | Type  | Description
|-------------|-------|----------
| ticket      | String| Must be sent as parameter to all subsequent api calls.
| tokenId     | String| Token id from loginAccount endpoint.
| eventHorizon| Number| Latest event client has seen.
| wait        | Select| Set to False if you want to get latest events but not stay waiting if there isn't any.
| downloadUrl | String| url from where to download new binary sent when server decides that client is too old and needs to be upgraded.

## Fleep.storingConnectionInformation
Handles long poll server side by storing connection information into connection table by the token.

| Field       | Type  | Description
|-------------|-------|----------
| ticket      | String| Must be sent as parameter to all subsequent api calls.
| tokenId     | String| Token id from loginAccount endpoint.
| eventHorizon| Number| Latest event client has seen.
| wait        | Select| Set to False if you want to get latest events but not stay waiting if there isn't any.
| pollFlags   | Select| Can be used to fine tune polls according to client needs. skip_hidden - skip hidden conversations during initial synchronize. skip_rest - skip other conversations and start polling events used for limiting number of conversations loaded into client cache.

## Fleep.synchronizeAccount
Use it to initialize some information using token.

| Field          | Type  | Description
|----------------|-------|----------
| ticket         | String| Must be sent as parameter to all subsequent api calls.
| tokenId        | String| Token id from loginAccount endpoint.
| eventHorizon   | Number| No point to read historic events either server must return good enough guess so that contacts and conversations will be.
| email          | String| Account's email.
| displayName    | String| Account's display name.
| accountId      | String| Account ID.
| mkAccountStatus| String| `new` - email has been registered but is goodness is unknown;`active` - user has stored a password and can participate;`banned` - user has been banned for some unacceptable activity;`closed` - user has requested this account to be closed;

## Fleep.getNextBatchOfConversations
Get next or previous batch of conversations.

| Field          | Type  | Description
|----------------|-------|----------
| ticket         | String| Must be sent as parameter to all subsequent api calls.
| tokenId        | String| Token id from loginAccount endpoint.
| conversationIds| List  | List of conversation id's to synchronize.
| mkInitMode     | Select| `ic_header` - header only.`ic_tiny` - for minimal.`ic_full` - ready for display.

## Fleep.addMembersToConversation
Add members to the conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Add members to the conversation by id.
| fromMessageNumber| Number| Used to return next batch of changes.
| email           | String  | Email address.

## Fleep.autojoinConversation
Autojoin conversation if not member yet.

| Field             | Type  | Description
|-------------------|-------|----------
| ticket            | String| Must be sent as parameter to all subsequent api calls.
| tokenId           | String| Token id from loginAccount endpoint.
| conversationUrlKey| String| Either convinfo.conversation_id or last part of convinfo.autojoin_url (KEY).

## Fleep.checkPermissions
Check if account has modification rights on the conversation. Same check is done in all conversation services so this here mainly helps with testing and documentation at first.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Check permission conversation by id.

## Fleep.convertConversation
Convert conversation to new API.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Convert conversation by id.

## Fleep.createConversation
Create new conversation.

| Field             | Type  | Description
|-------------------|-------|----------
| ticket            | String| Must be sent as parameter to all subsequent api calls.
| tokenId           | String| Token id from loginAccount endpoint.
| topic             | String| Conversation topic.
| email           | String  | email address.
| subject           | String| Subject for first message.
| message           | String| Initial message into the conversation.
| attachments       | List  | List of AttachmentInfos to be added to conversation.
| isInvite          | Select| Send out invite emails to fresh fleepers
| isAutojoin        | Select| Allow autojoin to the conversation.
| isDisclose        | Select| Enable/disable auto disclose.
| fwdConversationId | String| Forwarded conversation id (for forwarding html messages).
| teamIds           | List  | Add teams to conversation.
| accountIds        | List  | List of account ids.
| forkConversationId| String| Parent conversation.
| isList            | Select| Behaves as mailing list. Set true for group conversations with more than two members as a default.
| isManaged         | Select| Is this conversation managed conversation.
| mkConvType        | Select| Conversation type.

## Fleep.createVideoCall
Create a new (video)call.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| provider      | String| Call service provider (appear.in).
| roomName      | String| If not provided, room will have an unique random name.
| conversationId| String| Create video call by conversation id.

## Fleep.deleteConversation
Remove conversation from your conversation list. If you don’t leave conversation before deleting it will still reappear when someone writes in it.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Delete conversation by id.

## Fleep.discloseConversationHistory
Disclose conversation history to members until given message.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Disclose conversation by id.
| emails           | List  | List of email addresses like on email To: line.
| messageNumber    | Number| Disclose up to this message.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.discloseAllConversationsHistory
Disclose conversation history to members. All content of last membership is disclosed. 

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Disclose conversation by id.
| emails           | List  | List of email addresses like on email To: line.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.hideConversation
Hide conversation until new messages arrives. Useful for people who want to keep their inbox clear.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Hide conversation by id.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.leaveConversation
Leave the conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Leave conversation by id.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.getAllConversation
List all conversations for this account. Same conversations may pop up several times due to shifting order caused by incoming messages. Stop calling when you receive empty conversation list.

| Field             | Type  | Description
|-------------------|-------|----------
| ticket            | String| Must be sent as parameter to all subsequent api calls.
| tokenId           | String| Token id from loginAccount endpoint.
| synchronizeHorizon| Number| Keeps track of conversations loaded set 0 for first call.

## Fleep.markConversationAsRead
Mark conversation as read regardless of how many unread messages there are. Useful for marking read conversations that you are not planning to read. For example error log after it has rolled up thousands of messages. Returns init conversation stream so the client side conversation will be reset to new read position and all the possibly skipped messages will not get misinterpreted.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Leave conversation by id.
| mkInitMode    | Select| `ic_tiny` - for minimal.`ic_full` - ready for display.

## Fleep.sendPokeEven
Send poke event, used for testing synchronize between clients.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| messageNumber    | Number| Disclose up to this message.
| fromMessageNumber| Number| Used to return next batch of changes.
| isBgPoke         | Select| Go through bgworker.

## Fleep.removeMembersFromConversation
Remove members from the conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Leave conversation by id.
| fromMessageNumber| Number| Used to return next batch of changes.
| emails           | List  | List of email addresses like on email To: line.

## Fleep.setConversationAlerts
Set conversation alerts.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Used to return next batch of changes.
| mkAlertLevel     | Select| `never` - do not alert for this conversation;`default` - default behaviour.

## Fleep.changeConversationTopic
Change conversation topic.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Used to return next batch of changes.
| topic            | String| Conversation topic.

## Fleep.getActivity
Show writing pen and/or pinboard editing status. This works both ways. Any call activates this conversation for this account. So to start receiving activity call with empty parameters.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Conversation id.
| messageNumber | Number| Edited flow or pinboard message number.
| isWriting     | Select| true - writing, false - cancel

## Fleep.storeConversationHeaderFields
Store conversation header fields. Store only fields that have changed. Call only when cache is fully synced.

| Field               | Type  | Description
|---------------------|-------|----------
| ticket              | String| Must be sent as parameter to all subsequent api calls.
| tokenId             | String| Token id from loginAccount endpoint.
| conversationId      | String| Conversation id.
| readMessageNumber   | Number| New read horizon for conversation.
| labels              | List  | User labels for conversation.
| labelIds            | List  | User labels for conversation.
| topic               | String| Shared topic for conversation.
| mkAlertLevel        | Select| `never` - do not alert for this conversation;`default` - default behaviour.
| snoozeInterval      | String| For how long to snooze conversation in seconds.
| addEmail           | String  | Email to be added (map to fleep accounts if possible).
| removeEmail        | String  | Email to be removed (map to fleep accounts if possible).
| discloseEmail      | String  | Disclose conversation to these user.
| addAccountIds       | List  | Account ids to be added to the conversation.
| kickAccountIds      | List  | Account ids to be removed from the conversation with no access to history - only useable with managed conversations.
| removeAccountIds    | List  | Account ids to be removed from the conversation.
| discloseAccountIds  | List  | Disclose conversation to these users.
| hideMessageNumber   | Number| Hide the conversation from this message number.
| isDeleted           | Select| Set to true to delete the conversation.
| isDeletedByAdmin    | Select| Delete by admin (affects all members).
| fromMessageNumber   | Number| Used to return next batch of changes.
| isAutojoin          | Select| Enable disable auto join.
| isDisclose          | Select| Enable/disable auto disclose.
| canPost             | Select| Set to false to leave the conversation.
| isUrlPreviewDisabled| Select| Don't show url previews for all users.
| isList              | Select| Behaves as mailing list.
| addTeamIds          | List  | Add teams to conversation.
| removeTeamIds       | List  | Remove teams from conversation.
| isManaged           | Select| Is this conversation managed conversation.
| addAdmins           | List  | Add conversation admins. Allow settingi non organisation admins as admins for conv.
| removeAdmins        | List  | Remove conversation admins.
| mkConvType          | Select| Change conversation email behavior.

## Fleep.synchronizeStateForConversation
Synchronize state for single conversation. If used with default values 5 messages before and after last reported readMessageNumber are returned. Also all conversation state are returned: PinInfo, memberInfo. All optional fields (o) are returned for first synchronize. After that these are included only when there have been changes. Changes are detected from system messages in message flow.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Earliest message number client has received or previous messages are read and returned.
| mkDirection      | Select| mkDirection select.

##### Params list for mkDirection field.

1. ic_header - return only conversation header.
2. ic_tiny - do minimal init conversation returns only inbox message and header.
3. ic_full - do full initi conversation returns inbox message and several messages before and after current read horizon and several pins and several files.
4. ic_flow - get flow fragment returns several messages before and after given from_message_nr or current read horizon if from message nr not given.
5. ic_end - get flow fragment from the end of all available content.
6. ic_backward - get flow fragment before given message.
7. ic_forward - get flow fragment after given message  only visible messages are returned so not suitable for syncing cached conversation (edits will be lost).
8. ic_files - get only messages with files.
9. ic_pinboard - get only shared messages.
10. ic_tasks -get only archeved task messages.
11.  <null> - default behaviour get sequential messages forward. Returns all flow messages even non visible ones like edits of older messages.


## Fleep.synchronizeBackwardForConversation
Synchronize state for single conversation. Used to fetch messages for backward scroll.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Earliest message number client has received or previous messages are read and returned.

## Fleep.synchronizePinboardForConversation
Synchronize pinboard for conversation where it was not fully sent with init.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Earliest message number client has received or previous messages are read and returned.

## Fleep.synchronizeTeamsList
Synchronize teams.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.
| teamIds| List  | Add teams to conversation.

## Fleep.unhideConversation
Bring conversation out of hiding.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| fromMessageNumber| Number| Earliest message number client has received or previous messages are read and returned.

## Fleep.unsubscribeFromConversation
Unsubscribe from conversation.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Conversation id.
| email         | String| Email address to remove from conversation.

## Fleep.copyMessage
Copy message from another chat.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| messageNumber    | Number| Number of pinned message.
| toConversationId | String| Destination conversation.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.deleteMessageFromConversation
Delete message from conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Leave conversation by id.
| messageNumber    | Number| Number of pinned message.
| attachmentId     | String| Delete only given attachment.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.editConversationMessage
Edit conversation message.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| messageNumber    | Number| Number of pinned message.
| message          | String| Message content.
| attachments      | List  | List of AttachmentInfo objects(see in readme) to be added.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.markMessageAsRead
Set conversation read horizon for this account. Used when client determines that it has shown messages to user for long enough for them to get read or user wants to move read horizon up again.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| messageNumber    | Number| Client read horizon. Last message number that we have shown to user. We update database and send notifications to other connected clients if it is larger than current value in database.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.sendMessage
Send message to flow.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| conversationId   | String| Conversation id.
| message          | String| Message content.
| fromMessageNumber| Number| Used to return next batch of changes.
| isRetry          | Select| Client is retrying same message send n'th time. Will fail if fromMessageNumber != lastMessageNumber.
| attachments      | List  | List of attachment urls.

## Fleep.storeMessage
Store message changes whatever they are. Do changes in local cache and send only changed fields.

| Field                  | Type  | Description
|------------------------|-------|----------
| ticket                 | String| Must be sent as parameter to all subsequent api calls.
| tokenId                | String| Token id from loginAccount endpoint.
| conversationId         | String| Conversation id.
| message                | String| Message content.
| fromMessageNumber      | Number| Used to return next batch of changes.
| forwardedConversationId| String| Forwarded conversation id (for forwarding html messages).
| forwardedMessageNumber | String| Forwarded message number (for forwarding html messages).
| isUrlPreviewDisabled   | Select| Disable generating url previews for this message and remove if generated.
| isRetry                | Select| Client is retrying same message send n'th time. Will fail if fromMessageNumber != lastMessageNumber.
| messageNumber          | Number| Message number for edits and deletes.
| pinWeight              | Number| Used for sorting.
| CrapNetId              | Number| CrapNet id for message.
| attachments            | List  | List of attachment urls.
| assigneeIds            | List  | Assignees for task or message.
| tags                   | List  | List of tags for message;`pin` - pinned message;`is_todo` - task incomplete;`is_done` - done task;`is_separator` - task separator;`is_deleted` - message deleted;`is_archived` - pin or task archived;
| addReactions           | List  | Reactions to add.
| deleteReactions        | List  | Reactions to remove.
| subject                | String| Subject for first message.

## Fleep.getContentBySearchQuery
Set conversation read horizon for this account. Used when client determines that it has shown messages to user for long enough for them to get read or user wants to move read horizon up again.

| Field                | Type  | Description
|----------------------|-------|----------
| ticket               | String| Must be sent as parameter to all subsequent api calls.
| tokenId              | String| Token id from loginAccount endpoint.
| conversationId       | String| Limit search to one conversation.
| needSuggestions      | Select| Request suggestion list.
| keywords             | List  | Query search for content.
| ignoreConversationIds| List  | Client side matches no need to search duplicate matches.
| searchTypes          | List  | Do only search in specific areas`topic` - topic search only;`chat` - search in message content; `file` - search in file names; `pin` - search in pins;`task` - search in tasks.`subject` - search in email subjects;

## Fleep.loadIndexDataToCache
Load current user’s index data to cache.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.

## Fleep.dropIndexDataToCache
Drop user’s index from cache.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.

## Fleep.getSuggestWords
Suggest words.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| keywords      | List  | Query search for suggest words.
| conversationId| String| Limit search to one conversation.

## Fleep.describeFofContact
Provide description for the contact that will be displayed only to the user.

| Field      | Type  | Description
|------------|-------|----------
| ticket     | String| Must be sent as parameter to all subsequent api calls.
| tokenId    | String| Token id from loginAccount endpoint.
| contactId  | String| Contact id.
| contactName| String| Description to set.
| phoneNumber| String| Set users phone number.

## Fleep.hideContact
Hide contacts from this user’s contactlist.

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| contactIds| List  | List of contacts to hide.

## Fleep.importContact
Import contacts into users contactlist. Used for gmail contact import.

| Field   | Type  | Description
|---------|-------|----------
| ticket  | String| Must be sent as parameter to all subsequent api calls.
| tokenId | String| Token id from loginAccount endpoint.
| contacts| List  | List of ContactImport objects(see ContactInfo output below).

## Fleep.synchronizeContact
Returns profile data for given id. Use it to update local client side cache.

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| contactIds| List  | List of contactIds to synchronize.

## Fleep.synchronizeContactActivity
Synchronize last seen time for requested contacts.

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| contactIds| List  | List of account ids to synchronize.

## Fleep.synchronizeAllContact
Returns profile data for all. Use it to update local client side cache.

| Field       | Type  | Description
|-------------|-------|----------
| ticket      | String| Must be sent as parameter to all subsequent api calls.
| tokenId     | String| Token id from loginAccount endpoint.
| searchString| String| Returns profile data for given list of id’s. Use it to update local client side cache.
| ignoreIds   | List  | List of account ids client already has.

## Fleep.synchronizeContactList
Returns profile data for given list of id’s. Use it to update local client side cache.

| Field      | Type  | Description
|------------|-------|----------
| ticket     | String| Must be sent as parameter to all subsequent api calls.
| tokenId    | String| Token id from loginAccount endpoint.
| contactsIds| List  | List of account ids to synchronize.

## Fleep.removeContactFromConversation
Remove contact from conversation list dialog suggestions.

| Field      | Type  | Description
|------------|-------|----------
| ticket     | String| Must be sent as parameter to all subsequent api calls.
| tokenId    | String| Token id from loginAccount endpoint.
| contactsId | String  | Account id to synchronize.

## Fleep.uploadFile
Upload one or more files. File upload url-s can be used in message API calls storeMessage and sendMessage as attachments parameter.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.
| file   | File  | Input field for files.
| contentType| String| Content-Type of the file.Example - image/jpg.
| fileName| String| Name of the file.Example - file.jpeg

## Fleep.uploadExternalFile
Add file into Fleep from an external source. Maximum allowed file size is 1GB. Upload request is put into queue and processed by a background job. Upload progress events are sent to the client during the upload process.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| fileUrl       | String| Input field for files.
| fileName      | String| Name for files.
| fileSize      | String| max 1073741824.
| fileOrigin    | String| From where the file originates (Dropbox, Google Drive, Giphy, ...).
| conversationId| String| Needed, if file is related to a conversation.
| uploadId      | String| Upload id in client side.

## Fleep.addEmailAlias
Register email aliases for given account. Requires confirmation through email. All conversations are transferred under primary account as a result.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.
| email  | String| Email to be registered as alias.

## Fleep.confirmEmailAlias
Confirm that alias email received confirmation code.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| notificationId| String| Notification id.

## Fleep.removeEmailAlias
Remove email alias from given account.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.
| email  | String| Email to be removed.

## Fleep.synchronizeEmailAlias
Fetch all aliases for given account. Used for displaying aliases in UI.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.

## Fleep.configureConversationWebhook
Change webhook name and/or other settings.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| hookKey          | String| Hook key.
| hookName         | String| Name for hook.
| outgoingUrl      | String| URL for outgoing messages only relevant for plain and slack hooks.
| outgoingDisabled | Select| Whether outgoing URL functionality is disabled or not only relevant for plain and slack hooks.
| fromMessageNumber| Number| Used to return next batch of changes.

## Fleep.createConversationWebhook
Create webhook for given conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| hookType         | Select| Select hook type.
| hookName         | String| Name for hook.
| outgoingUrl      | String| URL for outgoing messages only relevant for plain and slack hooks.
| outgoingDisabled | Select| Whether outgoing URL functionality is disabled or not only relevant for plain and slack hooks.
| fromMessageNumber| Number| Used to return next batch of changes.
| externalAccountId| String| Id of the external account (see ExternalAccountInfo)only relevant for trello.
| externalObjectId | String| Id of the object in external system that should be hooked only relevant for trello (board id).
| conversationId   | String| Conversation by id.

## Fleep.removeConversationWebhook
Remove webhook from conversation.

| Field            | Type  | Description
|------------------|-------|----------
| ticket           | String| Must be sent as parameter to all subsequent api calls.
| tokenId          | String| Token id from loginAccount endpoint.
| hookKey          | String| Key used as identifier.
| fromMessageNumber| Number| Used to return next batch of changes.
| conversationId   | String| Conversation by id.

## Fleep.getConversationWebhook
Show webhooks in conversation.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| conversationId| String| Conversation by id.

## Fleep.autojoinToTeam
Autojoin team if not member yet. Autojoin url has following format https://fleep.io/team/KEY

| Field     | Type  | Description
|-----------|-------|----------
| ticket    | String| Must be sent as parameter to all subsequent api calls.
| tokenId   | String| Token id from loginAccount endpoint.
| teamUrlKey| String| Either teaminfo.team_id or last part of teaminfo.autojoin_url (KEY).

## Fleep.configureTeam
Add or remove members and change team name.

| Field              | Type  | Description
|--------------------|-------|----------
| ticket             | String| Must be sent as parameter to all subsequent api calls.
| tokenId            | String| Token id from loginAccount endpoint.
| team_name          | String| Team name.
| addEmail          | String  | Email to be added to team.
| removeEmail       | String  | Email to be removed from team.
| addConversations   | List  | List of conversation id's to add.
| removeConversations| List  | List of conversation id's to remove.
| addAccountIds      | List  | List of account ids to be added to team.
| removeAccountIds   | List  | List of account ids to be removed from team.
| kickAccountIds     | List  | List of account ids to be kicked from team , together with confistacion of managed history.
| addAdminIds        | List  | Add team admins.
| removeAdminIds     | List  | Remove team admins.
| isAutojoin         | Select| Is autojoin enabled.
| isManaged          | Select| Set team managed or not.

## Fleep.createTeam
Create team with given members and conversations.

| Field           | Type  | Description
|-----------------|-------|----------
| ticket          | String| Must be sent as parameter to all subsequent api calls.
| tokenId         | String| Token id from loginAccount endpoint.
| teamName        | String| Team name.
| addEmails       | String  | Email to be added to team.
| addConversations| List  | List of conversation id's to add.
| addAccountIds   | List  | List of account ids to be added to team.
| isAutojoin      | Select| Is autojoin enabled.
| isManaged       | Select| Set team managed or not.

## Fleep.removeTeam
Remove team.

| Field  | Type  | Description
|--------|-------|----------
| ticket | String| Must be sent as parameter to all subsequent api calls.
| tokenId| String| Token id from loginAccount endpoint.
| teamId | String| Team id.

## Fleep.synchronizeTeam
Synchronize team.

| Field         | Type  | Description
|---------------|-------|----------
| ticket        | String| Must be sent as parameter to all subsequent api calls.
| tokenId       | String| Token id from loginAccount endpoint.
| teamId        | String| Team id.
| conversationId| String| ConversationId to prove team access.


#Info about object from method response.

##ActivityInfo

mkrectype text = 'activity'
conversationid text - Conversation accountid text - Who is writing
iswriting boolean (o) - true - writing, false - cancel readmessagenr bigint (o) - read horizon for this user joinmessagenr bigint (o) - messsagenr from which user sees the conversation
activity_time bigint - when this activity happend

##BillingInfo   

mkrectype text = 'billing'
organisationid uuid countrycode text
billingdetails text billingemail text
vatnumber text planid text
accountquantity integer paymentmethodimageurl text
paymentmethoddescription text
paymentmethodexpirationdate text subscriptionstatus text - empty or "confirmed"
discount numeric - discount % between 0 and 1 (where applicable)
nextbillingdate bigint

##ContactInfo

mkrectype text = 'contact'
accountid text - Account ID email text (o) - Account email displayname text (o) - name to be displayed in conversations
mkaccountstatus text - See Classificators
ishiddenforadd boolean (o) - can this contact be shown when adding contacts mkemailinterval text (o) - filled only if requester accountid matches
avatarurls text (o) - json contains urls to avatar thumbnails contactname text (o) - Contact name visible only to contactlist owner
phonenr text (o) - Phone phone nr visible only to contactlist owner clientflags text (o) - List of flag names that are true for client
isfullprivacy boolean (o) - true if don't want to send and receive
conversation read level and writing status
activitytime bigint (o) - when user send or read something in fleep dialogid text (o) - id of the latest dialog with this user
aliasaccountids text - for owner account only list of it's alias account ids
trialendtime integer (o) - time whne trial ends, 0 for premium users
fleepaddress text (o) - users fleep id isnewsletterdisabled boolean (o) - enable/disbale newsetter sending sortrank integer (o) - show higher ranking contacts on top when filtering
exportprogress float (o) - history export progress, between 0 (started) and 1 (ready) exportfiles text - list of JSON encoded export files
clientsettings text (o) - JSON encoded client settings haspassword boolean (o) - Has user set password (or using google single sign in)
ispremium boolean (o) - Owner only. True if premium user. fullname text (o) - Users own display name (without my modifications)
isautomuteenabled boolean (o) - Owner only. Are incoming emails from new sources automuted
connectedemail text (o) - Email linking email address if set activatedtime bigint (o) - when user account was activated (email confirmed)
organisationid uuid (o) - contact is active member of this organisation organisationname text (o) - name of the organisation contact is in
isorgadmin boolean (o) - is user admin of the organisation
storageusedbytes integer (o) - number of bytes used in users file storage
storagequotabytes integer (o) - number of bytes allowed for user storage

##ConvInfo

mkrectype text = 'conv'
mkinitmode text - icheader - just header ictiny - minimal init
icfull - full init conversationid text - mostly needed for conversation create case
creatorid text - id of the account who created the conversation joinmessagenr bigint - messagenr when member was added to the conversation
Useful for determining if backward scroll is still possible
readmessagenr bigint - Current truth about read horizon. Normally it only
increased but sometimes user may mark some messages
unread.
mymessagenr bigint - next message that mentions me
showmessagenr bigint - number of latest visible message
lastmessagenr bigint - last message nr in the conversation or last message
that is shown in case of leaving conversation
inboxmessagenr bigint - point to the message to be displayed in conversation list
deletemessagenr bigint - content before that message has been deleted by user
disclosemessagenr bigint - earliest disclose done for this use
canpost boolean - true if profile is still in conevrsation and can post to this conversation topic text - topic. Returned when changed members text[] - list of account ids who are currently joined leavers text[] - list of account ids who have left conversation guests text[] - list of account ids who are addes as guests admins text[] - list of account ids who are admins in managed conversation lastmessagetime bigint - unix timestamp of last message in flow mkalertlevel text - should alerting from this conversation be supressed filehorizon bigint - used in case all files are not sent during init
pass it to api/conversation/syncfiles call as frommessagenr pinhorizon bigint - used in case all pins are not sent during init
pass it to api/conversation/syncpinboard call as frommessagenr taskhorizon bigint - used to sync all tasks including archived tasks to client
hidemessagenr bigint - if conversation last message nr is equal or smaller than
hide message nr then conversation is to be hidden in client
fwmessagenr bigint - when syncing conversation forward mesage nr shows
forward progress and all is synced when it equals lastmessagenr
bwmessagenr bigint - when syncing conversation backward message nr shows
backward progress and all is synced when it equals joinmessagenr
unreadcount bigint - number of unread messages in conversation lastinboxnr bigint - inbox number of last alerting inbox message. Can be used locally to reduce unread count while server asyncronously does the same inboxtime bigint - weight of the conversation for sorting in conversation list
and left menu
isdeleted boolean - If set to true by server conversation must be deleted from client cache. istiny boolean - stream contains minimal amount of information needed for displaying
conversation in list
isinit boolean - server requests cache reset for this conversation. Used for changes like disclose and rejoin teams text[] - list of team id's that are part of this conversation labels text[] - labels user has for this conversation labelids uuid[] - Account label id's for this conversation
cmail text - conversation email address, sending email to this address
posts message in the conversation
snoozeinterval bigint - For how long to snooze conversation in seconds ispremium boolean - At least one member is premium user
haspinboard boolean - Conversation has content on pinboard hastaskboard boolean - Conversation has conetnt on taskboard
hastaskarchive boolean - Conversation has archived tasks
hasemailsubject boolean - Message entry area should show email subject
isautojoin boolean - Is autojoin enabled autojoinurl text - Url that can be used to autojoin conversation
clientreqid uuid - last req id to change this conversation if changed
using conversation store api call
ismarkunread boolean - true if last read activity was mark unread
isurlpreviewdisabled boolean - Don't show url previews for this message isdisclose boolean - Is disclosed to new joiners
isautomute boolean - Is this conversation automatically muted on creation defaulttopic text - Topic to be shown when user has not enterd it
defaultmembers text[] - list of account id's used to create default topic exportprogress float (o) - history export progress, between 0 (started) and 1 (ready)
export_files text - list of JSON encoded export files

mkconvtype text - 'cctlist' / 'cctdefault' / 'cctnomail'
islist boolean - If set to true list behavior is enabled else set to false ismanaged boolean - is this conversation managed
organisationid uuid - organisation who has claimed management of this conversation pincursor text - Cursor for pinboard sync

##ExternalAccountInfo

mkrectype text = 'externalaccount' externalaccountid uuid - record id accountid uuid - account owner
mkexternalaccounttype text - type of the connected account: trello externalid text - account id in the external system
email text - email in the external system

##FileInfo

mkrectype text = 'file'
conversationid text - conversation where this file is messagenr bigint - message to which file is attached
accountid text - Author ID attachmentid text - key assign by client in message
filesha256 text - file hash, can be used to identify same files filename text - file name
fileurl text - file url filesize bigint - File size in bytes
filetype text - server validated file type height integer - height for pictures width integer - width for pictures isanimated boolean - is animated gif
thumburlXX text - thumbail url for size XX

isdeleted boolean - filled when file is removed from message ishidden boolean - True, if file is an inline image inside of a quote or signature
deleterid text - User who deleted file. If present message should be shown in message flow. postedtime bigint - unix timestamp in seconds
orientation bigint - file orientation, for images
sender_name text - sender name if from email or hook

##HookInfo

mkrectype text = 'hook'
conversationid uuid - Conversation accountid uuid - Creator of the hook
hookname text - Hooks display name in chat. If not provided owners display name is used hookkey text - Used for removing th hook
hookurl text - Url that can be used to send data into chat filled only for the owner isactive boolean - is this hook currently active or for
historical data
mkhooktype text - bitbucket, confluence, github, gitlab, ifttt, jira, newrelic,
pivotaltracker, plain (generic webhook), sameroom, slack, trello,
zapier
avatarurls text - Avatar displayed for hook messages outgoingurl text (o) - URL that can be used to send out messages from this chat
filled only for the owner
outgoingdisabled boolean (o) - whether outgoing functionality is disabled or not filled only for the owner when outgoingurl is present
outgoingdisablereason text (o) - the reason why outgoing functionality is disabled
filled only for the owner when outgoing_disabled is true

##LabelInfo

mkrectype text = ‘label’ label text – Label name labelid text – label id index bigint – Label index (-1 -> remove label) mklabeltype text – Label type (userlabel/system_label)

system labels cannot be renamed or deleted
mklabelsubtype text – more finegrained label type
user - user starred - starred conversations recent - recent inbox conversations muted - muted conversations archived - archived conversatione unread - unread conversations spam - conversations marked as spam teamlabel - label for team conversations mklabelstatus text – active / revoved removed labels should be dropped from cache isonleftpane boolean – should label be shown on left pane isinrecent boolean – are conversations with this label shown

in RECENT section on left pane cannot be changed for system labels
isinmuted boolean – are conversations with this label shown
in MUTED section on left pane cannot be changed for system labels
syncinboxtime bigint – inbox time until which synced or 0 if in the end syncconversationid text – conversation id inside inbox time for ordering synccursor text – cursor for fetching next batch teamid text – team id for team labels

##LastSeenInfo

mkrectype text = 'lastseen'
accountid text - Who is writing activitytime bigint - when this activity happend

##LockInfo

mkrectype text = 'lock'
conversationid text - mostly needed for conversation create case messagenr bigint - message sequence number in message flow
lockaccountid text (o) - who is locking message for editing

##MailInfo

mkrectype text = ‘mail’

mail_id uuid – mail record id

mail_address text – mail address

smtpusername text – smtp username smtphost text – smtp host smtpport bigint – smtp port mksmtpconnection text – ‘ssl’/’starttls’ smtperr text = None – smtp error smtpdisabletls_verify bool

imapusername text – imap username imaphost text – imap host imapport bigint – imap port mkimapconnection text – ‘ssl’ / ‘starttls’ imaperr text = None – imap error imapdisabletls_verify bool

mkmailtype text – ‘mail’ / ‘gmail’ mkmailstatus text – ‘mailadd’ / ‘mailfailed’ / ‘mailconfirmed’ / ‘mailremoved’

##MessageInfo

mkrectype text = 'message'
mkmsgsubtype text - for future use, more finegrained message type handling conversationid text - mostly needed for conversation create case
messagenr bigint - message sequence number in message flow subject text - optional subject used for outgoing emails message text - message body - XML. markedtext text - used in search result to highlight marked text
accountid text - Author ID mkmessagetype text - see Classificators flowmessagenr bigint - In case this message is edit or delete of one of the earlier messages revisionmessagenr bigint - Latest visible revision postedtime bigint - unix timestamp in seconds
pinweight numeric - may be filled for pin messages apply only if filled refmessagenr bigint - used by messages that need ot reference other messages like unpin message fro example editaccountid text - ref to message revisor, normally same as author but may be different for pinned messages and files editedtime bigint - message edit time
tags text[] - list of message flags. Possible values:
pin - message is on pinboard
istodo - message is task isdone - message is task that has been completed
isseparator - separator for tasks isarchived - message has been archived
isdeleted - message has been delete isnewsheet - this msg starts new sheet ishidden - do not render message in flow
iseditedbyothers - someone has edited this message lockaccountid text - in case pin is locked for editing inboxnr bigint - inbox number of message. Only alerting messages are
assigned inbox numbers. So lastinboxnr - inboxnr should give number of alerting messages. Negative values point to previous inbox number from this message. hookkey text - filled if message was sent via hook
prevmessagenr bigint - number of previous visible message
isnewsheet boolean - start new sheet in message flow
sendername text - Name of sender provided by hook or some other source assigneeids uuid[] - People assigned to this task or message
isurlpreviewdisabled boolean - Don't show url previews for this message onbehalfid text - used for emails when email is sent by another user markedtext text - used with search. Search marks matches in message text
mkmessagestate text - current message state
sectionid uuid - task section id isspam boolean - message is marked as spam
iseditedbyothers boolean - non author has edited the message pinnedaccountid uuid - account that pinned the message taskedaccount_id uuid - account that tasked the message

##OrgMemberInfo

mkrectype text = 'orgmember' organisationid uuid
accountid uuid mkmemberstatus text -- See Business Memeber Status belo -- bmspending - waiting user accept
-- bmsactive - in use or ready for it -- bmsremoved - released from org
-- bmsclosed - account closed -- bmssuspended - suspended by admin
-- bmsdeclined - user declined -- bmsexpired - invitation expired
is_admin boolean -- true if user is admin

##OrgInfo

mkrectype text = 'orgheader' organisationid uuid
organisationfounderid uuid
organisationname text avatarurls text
versionnr bigint status text trialtime bigint
gracetime bigint isadmin boolean
ismember boolean -- is current user member of the organisation invoicepayments boolean -- is organisation using invoice payments

##PreviewInfo

mkrectype text = 'preview'
conversationid text - conversation where this file is messagenr bigint - message to which file is attached
accountid text - Author ID attachedurl text - url being previewed
title text - Title extracted from source
description text - Descrition extracted from source
filesha256 text - file hash, can be used to identify same files filename text - file name
fileurl text - file url filesize bigint - File size in bytes
filetype text - server validated file type height integer - height for pictures width integer - width for pictures isanimated boolean - is animated gif
thumburlXX text - thumbail url for size XX

isdeleted boolean - filled whne file is removed from message deleterid text - User who deleted file. If present message should
be shown in message flow.

##ReminderInfo

mkrectype text = 'reminder'
reminderid uuid accountid uuid
mkremindertype text
remindtime bigint expiretime bigint
organisationid uuid isactive boolean
creator_id uuid -- who submitted reminder if not the author

##RequestInfo

mkrectype text = 'request'
clientreqid uuid - Client request has been processed and all data changes
are commited into database and they have all been
sent through poll also
conversationid uuid (o) - Conversation changed by request resultmessage_nr bigint (o) - Message that was created or modified with this request

##SectionInfo

mkrectype text = 'section'
conversationid uuid - Conversation id sectionid uuid - Section id
name text - Section name
mksectiontype text - Section type
mksectionsubtype text - Section subtype
isdeleted boolean - Is section deleted weight float - Section weight synccursor text - Cursor for sync dependent on mksectiontype

##SMTPInfo

mkrectype text = ‘smtp’ – smtpid uuid – SMTP record id smtpaddress text – SMTP email address smtpusername text – SMTP username smtphost text – SMTP host smtpport bigint – user specified SMTP port (may be None) smtpconnection text – ‘ssl’ / ‘starttls’ mksmtpstatus text – SMTP record status

– smtpadded: record added but not confirmed – smtpfailed: record failed – smtpconfirmed: record confirmed – smtpremoved: record removed
smtpstatusdescription text – human readable status descropion
– most notably used to deliver error messages – when the record has failed

##TeamInfo

mkrectype text = 'team'
teamid uuid - Id for team used in conversation heder to map all the teams that are part of the conversation mksyncmode text - 'tsmfull' / 'tsmsnapshot' current or snapshot version of the team teamversionnr bigint - Version number of the team record teamname text (o) - Name of the team
members text - List of accountid's who are part of the team admins text - List of accountid's who can change team membership
isdeleted boolean - Whether the team is deleted istiny boolean - Whether it is the full record or not (istiny is used to to sync limited data to non members) isautojoin boolean (o) - Is autojoin enabled
organisationid text (o) - Organisation in case of managed teams autojoinurl text - Autojoin url to join team
is_managed boolean - is this a managed team

##TransactionInfo

mkrectype text = 'transaction'
organisationid uuid transactionid uuid
amount numeric
transactiontime bigint downloadurl text

##UploadInfo

mkrectype text = 'upload'
status text - 'pending, 'success' or 'failure'
progress integer - between 0 and 100, given if status is 'pending'
conversationid text - conversation related to the upload request requestid text - upload request id given by server
uploadid text - upload id given by client filetype text - server validated file type
name text - file name
size bigint - file size
filesha256 text - file hash, can be used to identify same files height integer - height for pictures width integer - width for pictures isanimated boolean - is animated gif
upload_url text
error text - error description, given if status is 'failure'
```

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication