Events

Table Of Contents

urn:fleep:client:account:add_flag

Params:

{
  "client_flag": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:change_password

Change owners password

Params:

{
  "password": {
    "type": "TEXT",
    "max_len": 128
  },
  "old_password": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:change_settings

Change owners client settings

Params:

{
  "client_settings": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:remove_flag

Params:

{
  "client_flag": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:set_mk_push_new_message

Set account push logic on new messages.

Params:

{
  "mk_push_new_message": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:set_name

Set owners display name that searchable and visible to others

Params:

{
  "name": {
    "type": "TEXT",
    "max_len": 128
  }
}

urn:fleep:client:account:set_phone

Set owners phonr number that searchable and visible to others

Params:

{
  "phone_nr": {
    "type": "TEXT",
    "max_len": 16
  }
}

urn:fleep:client:account:set_sleep_interval

Set account sleep interval.

Params:

{
  "sleep_interval": {
    "type": "BIGINT"
  }
}

urn:fleep:client:account:sync_conversations

Sync conversations accessible to account

Params:

{
  "conversation_ids": {
    "type": "[UUID]"
  },
  "mk_init_mode": {
    "type": "TEXT",
    "default": "ic_header",
    "max_len": 1024,
    "options": [
      "ic_full",
      "ic_header",
      "ic_tiny"
    ]
  }
}

urn:fleep:client:account:update_status_message

Update status message.

Params:

{
  "status_emoji": {
    "type": "TEXT",
    "max_len": 1024
  },
  "status_message": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:account:upload_external

Upload private external file.

Params:

{
  "file_url": {
    "type": "TEXT",
    "max_len": 2048
  },
  "file_name": {
    "type": "TEXT",
    "max_len": 2048
  },
  "file_size": {
    "type": "BIGINT",
    "default": "0"
  },
  "file_origin": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "upload_id": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  }
}

urn:fleep:client:contact:add

Add contact.

Params:

{
  "email": {
    "type": "TEXT",
    "max_len": 1024
  },
  "name": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "phone_nr": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  }
}

urn:fleep:client:contact:get

Get contact.

Params:

{
  "account_id": {
    "type": "UUID"
  }
}

urn:fleep:client:contact:get_dialog

Get dialog.

Params:

{
  "account_id": {
    "type": "UUID"
  },
  "mk_conv_type": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024,
    "options": [
      "cct_default",
      "cct_no_mail"
    ]
  }
}

urn:fleep:client:contact:hide

Contact Hide

Params:

{
  "account_id": {
    "type": "UUID"
  }
}

urn:fleep:client:contact:hide_contacts

Hide list of contacts

Params:

{
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:contact:import

Import contacts.

Params:

{
  "contacts": {
    "type": "[OBJECT]",
    "params": {
      "email": {
        "type": "TEXT",
        "max_len": 1024
      },
      "name": {
        "type": "TEXT",
        "default": "NULL",
        "max_len": 1024
      },
      "phone_nr": {
        "type": "TEXT",
        "default": "NULL",
        "max_len": 1024
      }
    }
  }
}

urn:fleep:client:contact:lookup_by_email

Lookup contacts by email.

Params:

{
  "email": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:contact:set_name

Set Name

Params:

{
  "account_id": {
    "type": "UUID"
  },
  "name": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:contact:set_phone

Set contacts phone number visible only to self

Params:

{
  "account_id": {
    "type": "UUID"
  },
  "phone_nr": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:contact:sync

Sync contacts sorted by sort rank.

Params:

{
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "account_id": {
        "type": "UUID"
      },
      "sort_rank": {
        "type": "BIGINT"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "100",
    "ignore": true
  }
}

urn:fleep:client:contact:sync_activity

Sync last seen info for requested accounts.

Params:

{
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:contact:sync_canned

Sync canned response.

Params:

{
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "message_id": {
        "type": "UUID"
      },
      "store_time": {
        "type": "TIMESTAMPTZ"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:conv:activate

Activate conversation for 10 minutes.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:add_admins

Add admins to managed conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:conv:add_members

Add members.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]"
  },
  "is_business": {
    "type": "BOOLEAN",
    "default": "NULL"
  }
}

urn:fleep:client:conv:add_team

Add team to conversation

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "team_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:archive

Archive conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "show_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:conv:autojoin

Try to join or rejoint the conversation it it has is_autojoin enabled

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_deleted_by_admin

Only admin can delete conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_disable_autojoin

Disable autojoin. Need a link to join conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_disable_disclose

Disable automatic disclose when new members join conversation

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_disable_url_previw

Disable url link preview.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_enable_autojoin

Enable autojoin. Anyone with the link can join.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_enable_disclose

Enable automatic disclose of conversation history

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:conv_enable_url_preview

Enable url link preview.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:create

Create conversation

Params:

{
  "topic": {
    "type": "TEXT",
    "default": "",
    "max_len": 256
  },
  "account_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "team_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "is_autojoin": {
    "type": "BOOLEAN",
    "default": "False",
    "description": "Anyone can join using conversaion autojoin link"
  },
  "is_disclose": {
    "type": "BOOLEAN",
    "default": "False",
    "description": "Previous content is automatically disclosed to joiners"
  },
  "is_managed": {
    "type": "BOOLEAN",
    "default": "False",
    "description": "Organisation admins can manage this conversation"
  },
  "mk_conv_type": {
    "type": "TEXT",
    "default": "cct_no_mail",
    "max_len": 1024,
    "options": [
      "cct_list",
      "cct_no_mail",
      "cct_default"
    ]
  }
}

urn:fleep:client:conv:delete

Delete conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:disable_admin_write_only

Disable admin write only.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:disable_done_notifications

Disable done notifications.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:disable_notifications

Disable push & email notifications.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:disclose

Disclose conversation history to given members/teams

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "team_ids": {
    "type": "[UUID]",
    "default": "NULL"
  }
}

urn:fleep:client:conv:enable_admin_write_only

Enable admin write only.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:enable_done_notifications

Enable done notifications.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:enable_notifications

Enable push & email notifications.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:end_writing

Cancel writing pen for user

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:fork

Fork conversation. Used to preseve dialogs when members get added to them.

Params:

{
  "conversation_id": {
    "type": "UUID",
    "description": "Dialog being forked into larger conversation"
  },
  "account_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "team_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "is_managed": {
    "type": "BOOLEAN",
    "default": "False"
  },
  "mk_conv_type": {
    "type": "TEXT",
    "default": "cct_no_mail",
    "max_len": 1024,
    "options": [
      "cct_list",
      "cct_no_mail",
      "cct_default"
    ]
  }
}

urn:fleep:client:conv:get

Sync conversation message flow forward in time

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:kick_members

Remove/kick members.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:conv:leave

Leave the conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:mark_read

Mark conversation read until last visible message nr

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "show_message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:conv:mark_unread

Mark conversation read until last visible message nr

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "inbox_message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:conv:mute

Mute conversation until unmuted by user

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:mute_until

Mute for duration of seconds in snooze interval

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "snooze_interval": {
    "type": "BIGINT"
  }
}

urn:fleep:client:conv:mute_until_read

SetTimeInterval for snooze/mute.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:pin:sync

Sync pinboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "conversation_id": {
        "type": "UUID"
      },
      "pin_weight": {
        "type": "FLOAT",
        "default": "NULL"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:conv:remove_admins

Remove admins from managed conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:conv:remove_members

Remove members.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:conv:remove_team

Remove team from conversation

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "team_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:set_alert_level

Set conversation alert level

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "mk_alert_level": {
    "type": "TEXT",
    "max_len": 1024,
    "options": [
      "never",
      "default",
      "until_read",
      "passive"
    ]
  }
}

urn:fleep:client:conv:set_default_call_room

Set default appear.in roomname.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "default_call_room": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:conv:set_labels

Set conversation labels

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "label_ids": {
    "type": "[UUID]"
  }
}

urn:fleep:client:conv:set_managed

Only admins can manage conversation settings.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:set_passive

Become passive member of conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:set_read_message_nr

Mark conversation read until given message nr.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:conv:set_snooze

SetTimeInterval for snooze/mute.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "snooze_interval": {
    "type": "BIGINT"
  }
}

urn:fleep:client:conv:set_topic

Set conversation topic

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "topic": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:conv:set_type

Set conversation type

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "mk_conv_type": {
    "type": "TEXT",
    "max_len": 1024,
    "options": [
      "cct_list",
      "cct_no_mail",
      "cct_default"
    ]
  }
}

urn:fleep:client:conv:set_unmanaged

Only admins can unmanage conversation settings.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:set_writing

Show writing pen for 30 seconds to other conversation participants

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:sync_backward

Sync conversation message flow backward in time

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "bw_message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:conv:sync_files

Sync file drawer

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "conversation_id": {
        "type": "UUID"
      },
      "message_nr": {
        "type": "BIGINT",
        "default": "NULL"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:conv:sync_files:2

Sync file drawer

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "file_sync_state": {
    "type": "OBJECT",
    "default": "NULL",
    "params": {
      "limit": {
        "type": "OBJECT",
        "params": {
          "message_nr": {
            "type": "BIGINT"
          }
        }
      },
      "sync_cursor": {
        "type": "CURSOR",
        "params": {
          "conversation_id": {
            "type": "UUID"
          },
          "message_nr": {
            "type": "BIGINT"
          }
        }
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:conv:sync_forward

Sync conversation message flow forward in time

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "fw_message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:conv:sync_initial

Sync conversation message flow forward in time

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:unarchive

Unarchive conversation.

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:unmute

Unmute conversation

Params:

{
  "conversation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:conv:upload_external

Upload external file to conv.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "file_url": {
    "type": "TEXT",
    "max_len": 2048
  },
  "file_name": {
    "type": "TEXT",
    "max_len": 2048
  },
  "file_size": {
    "type": "BIGINT",
    "default": "0"
  },
  "file_origin": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "upload_id": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  }
}

urn:fleep:client:label:sync_conversations

Sync label conversations

Params:

{
  "label_id": {
    "type": "UUID"
  },
  "mk_init_mode": {
    "type": "TEXT",
    "default": "ic_tiny",
    "max_len": 1024,
    "options": [
      "ic_full",
      "ic_header",
      "ic_tiny"
    ]
  },
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "acv_conv_id": {
        "type": "UUID"
      },
      "acv_inbox_time": {
        "type": "TIMESTAMPTZ"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "30",
    "ignore": true
  }
}

urn:fleep:client:message:add_pinned

Add pinned message.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 307200
  },
  "subject": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:add_plain

Add plain message.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 307200
  },
  "subject": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  },
  "reply_to_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:add_reaction

Add reaction.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "reaction": {
    "type": "TEXT",
    "max_len": 1024
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:add_todo

Add todo message.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 307200
  },
  "subject": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "assignee_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:archive

Archive task.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:copy

Copy message from one chat to another.

Params:

{
  "conversation_id": {
    "type": "UUID",
    "description": "Destination conversation id"
  },
  "copy_conversation_id": {
    "type": "UUID",
    "description": "Origin conversation id"
  },
  "copy_message_nr": {
    "type": "BIGINT",
    "description": "Origin message nr"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:delete

Delete message.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:delete_attachments

Delete message attachments.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:delete_reaction

Delete reaction.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "reaction": {
    "type": "TEXT",
    "max_len": 1024
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:disable_preview

Disable preview.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:disclose

Disclose conversation history to given members/teams

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "account_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "team_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:edit

Edit message content. Missing or NULL params are removed from the message.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "message": {
    "type": "TEXT",
    "max_len": 307200
  },
  "subject": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:edit_attachments

Edit message attachments.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:edit_body

Edit message body.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 307200
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:edit_subject

Edit message subject.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "subject": {
    "type": "TEXT",
    "default": "NULL",
    "max_len": 1024
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:end_editing

Cancel message edit

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:load_context

Load messages around given message to show it’s context

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:load_next

Load next messages from given message to fill the gap

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:load_previous

Load previous messages from given messages to fill the gap

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:mark_read

Mark conversation read until given message nr.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:mark_spam

Mark spam.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:mark_unread

Mark conversation read until given message nr.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:pin:set_position

Reposition pin.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "prev_message_nr": {
    "type": "BIGINT",
    "description": "Message nr after which to position the pin. 0 if first position."
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_assignees

Set assignees.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "assignee_ids": {
    "type": "[UUID]",
    "default": "NULL"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_done

Turn message to done.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_editing

Lock message for editing

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  }
}

urn:fleep:client:message:set_pinned

Turn message to pinned.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_plain

Turn message to plain.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_spam

Set spam.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "is_spam": {
    "type": "BOOLEAN"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_todo

Turn message to todo.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:set_unpinned

Turn message to unpinned.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:task:set_position

Reposition task.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "section_id": {
    "type": "UUID"
  },
  "prev_message_nr": {
    "type": "BIGINT",
    "description": "Message nr after which to position the task. 0 if first position."
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:unarchive

Unarchive task.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:message:unmark_spam

Unmark spam.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "message_nr": {
    "type": "BIGINT"
  },
  "from_message_nr": {
    "type": "BIGINT",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:add_canned

Add canned response

Params:

{
  "canned_name": {
    "type": "TEXT",
    "max_len": 1024
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 1024
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:add_todo

Add todo message to my taskboard.

Params:

{
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 307200
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:archive

Archive message.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_message:delete

Delete message.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_message:edit

Edit message content. Missing or NULL params are removed from the message.

Params:

{
  "message_id": {
    "type": "UUID"
  },
  "message": {
    "type": "TEXT",
    "max_len": 307200
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:edit_attachments

Edit message attachments.

Params:

{
  "message_id": {
    "type": "UUID"
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:edit_body

Edit message body.

Params:

{
  "message_id": {
    "type": "UUID"
  },
  "message": {
    "type": "TEXT",
    "max_len": 307200
  }
}

urn:fleep:client:my_message:edit_canned

Edit canned response

Params:

{
  "canned_name": {
    "type": "TEXT",
    "max_len": 1024
  },
  "message": {
    "type": "TEXT",
    "default": "",
    "max_len": 1024
  },
  "message_id": {
    "type": "UUID"
  },
  "attachment_urls": {
    "type": "[TEXT]",
    "default": "NULL"
  }
}

urn:fleep:client:my_message:set_done

Turn message to done.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_message:set_todo

Turn message to done.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_message:unarchive

Unarchive message.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_section:task:add

Add section to my taskboard.

Params:

{
  "section_name": {
    "type": "TEXT",
    "max_len": 1024
  },
  "prev_section_id": {
    "type": "UUID",
    "default": "NULL"
  },
  "mk_section_type": {
    "type": "TEXT",
    "default": "urn:fleep:my_section:mk_section_type:my_task",
    "max_len": 1024,
    "options": [
      "urn:fleep:my_section:mk_section_type:my_task"
    ]
  }
}

urn:fleep:client:my_section:task:archive_all

Archive all tasks.

Params:

{
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_section:task:archive_done

Archive done tasks.

Params:

{
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_section:task:delete

Delete section from my taskboard.

Params:

{
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:my_section:task:rename

Delete section from my taskboard.

Params:

{
  "section_id": {
    "type": "UUID"
  },
  "section_name": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:my_section:task:set_position

Position section in my taskboard.

Params:

{
  "section_id": {
    "type": "UUID"
  },
  "prev_section_id": {
    "type": "UUID",
    "default": "NULL"
  }
}

urn:fleep:client:my_section:task:sync

Sync my taskboard.

Params:

{
  "section_id": {
    "type": "UUID"
  },
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "section_id": {
        "type": "UUID"
      },
      "task_weight": {
        "type": "FLOAT",
        "default": "NULL"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:organisation:get

Get organisation ecord containing only publicly available information

Params:

{
  "organisation_id": {
    "type": "UUID"
  }
}

urn:fleep:client:section:task:add

Add section to conversation taskboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_name": {
    "type": "TEXT",
    "max_len": 1024
  },
  "prev_section_id": {
    "type": "UUID",
    "default": "NULL"
  }
}

urn:fleep:client:section:task:archive_all

Archive all messages in section.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:section:task:archive_done

Archive done messages in section.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:section:task:delete

Delete section from conversation taskboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  }
}

urn:fleep:client:section:task:rename

Delete section from conversation taskboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  },
  "section_name": {
    "type": "TEXT",
    "max_len": 1024
  }
}

urn:fleep:client:section:task:set_position

Position section in conversation taskboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  },
  "prev_section_id": {
    "type": "UUID",
    "default": "NULL"
  }
}

urn:fleep:client:section:task:sync

Sync taskboard.

Params:

{
  "conversation_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  },
  "sync_cursor": {
    "type": "CURSOR",
    "default": "NULL",
    "params": {
      "conversation_id": {
        "type": "UUID"
      },
      "section_id": {
        "type": "UUID"
      },
      "task_weight": {
        "type": "FLOAT",
        "default": "NULL"
      }
    }
  },
  "limit": {
    "type": "BIGINT",
    "default": "20",
    "description": "Batch size between 1 and 100",
    "ignore": true
  }
}

urn:fleep:client:task:archive

Archive both private and conv messages on my taskboard.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:task:set_position

Reposition task on my taskboard.

Params:

{
  "message_id": {
    "type": "UUID"
  },
  "section_id": {
    "type": "UUID"
  },
  "prev_message_id": {
    "type": "UUID",
    "default": "NULL",
    "description": "Message id after which to position the task. null if first position."
  }
}

urn:fleep:client:task:unarchive

Unarchive both private and conv messages on my taskboard.

Params:

{
  "message_id": {
    "type": "UUID"
  }
}

urn:fleep:client:team:get

Get team data containing only publicly available information

Params:

{
  "team_id": {
    "type": "UUID"
  },
  "conversation_id": {
    "type": "UUID",
    "default": "NULL"
  }
}

Table Of Contents

Previous topic

Stream API

Next topic

Fleep as a Platform