Account management

account/configure

URL: https://fleep.io/api/account/configure

Change account related settings

Input:

display_name            text        -- Name displayed instead of email in chats
old_password            text        -- required when submitting new password
password                text        -- new password
phone_nr                text        -- user's phone number
email_interval          text        -- email interval
is_full_privacy         boolean     -- stop sending out reading writing activity
is_newsletter_disabled  boolean     -- enable/disable newsletter sending
is_automute_enabled     boolean     -- enable/disable incoming email automute
client_settings         text        -- json encoded dict of changed client settings
fleep_address           text        -- Set fleep address (results in error if account already has one)

Output:

account/configure_email_interval

URL: https://fleep.io/api/account/configure_email_interval

Configure email notification settings with notification_id.

Input:

notification_id     text        - notification token
email_interval      text        - email interval ('hourly', 'daily', 'never')

account/configure_primary_email

URL: https://fleep.io/api/account/configure_primary_email

Set an existing alias as your new primary email address

Input:

primary_email       text        - Set new primary email (it has to be confirmed as alias first)

account/confirm

URL: https://fleep.io/api/account/confirm

Confirm receiving email with confirmation code and activate account.

Input:

notification_id     text = null     - notification token

Output:

account_id          text            - internal account id
display_name        text            - name to be displayed in conversations
profiles            list            - stream of ContactInfo records
ticket              text            - Must be sent as parameter to all
                                      subsequent api calls

ContactInfo:

account/confirm/v2

URL: https://fleep.io/api/account/confirm/v2

Confirm receiving email and configure account.

Input:

notification_id         text        - notification token
display_name            text        - display name
password                text        - password
fleep_address           text        - fleep address
phone_nr                text        - user's phone number (optional)
is_newsletter_disabled  boolean     - whether newsletter sending is disabled or not (optional, default True)

Output:

account_id          text            - internal account id
display_name        text            - name to be displayed in conversations
profiles            list            - stream of ContactInfo records
ticket              text            - Must be sent as parameter to all
                                      subsequent api calls
phone_nr            text            - user's phone number

ContactInfo:

account/export/start

URL: https://fleep.io/api/account/export/start

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

Input:

export_action       text = 'history_all'    - What to export: history_all - conversation history, all file types
conversation_id     uuid = None             - If set, generate files for this conversation only,
                                              and return ConvInfo else return ContactInfo

Output:

:ref:`ContactInfo <info/contactinfo>`
:ref:`ConvInfo <info/convinfo>`

account/external/account/list

URL: https://fleep.io/api/account/external/account/list

Input:

mk_external_account_type    text (o)    - type of the connected external account: trello
mk_permission_type          text (o)    - type of permissions that external account has granted
                                          to Fleep create_hook

Output:

stream                      list        -  list of ExternalAccountInfo records

ExternalAccountInfo:

account/lookup

URL: https://fleep.io/api/account/lookup

Lookup accounts.

Input:

lookup_list       text[]         - List of lookup strings
ignore_list       uuid[]         - List of account_id's to ignore

Output:

stream            list           - List of contact records

account/phone/confirm_pin

URL: https://fleep.io/api/account/phone/confirm_pin

Confirm phone number.

Input::
phone_nr text pin text

account/phone/resend_pin

URL: https://fleep.io/api/account/phone/resend_pin

Resend pin to confirm phone number.

Input::
phone_nr text

account/prepare/v2

URL: https://fleep.io/api/account/prepare/v2

Get notification_id for further requests.

Input:

notification_id     uuid = None     -- notification_id
registration_code   text = None     -- registration code
registration_mail   text = None     -- registration mail

Output:

notification_id     text            -- notification_id
display_name        text (o)        -- display name suggestion
email_address       text (o)        -- invite email address

team_id             uuid (o)        -- team id

organisation_id     uuid (o)        -- organisation id
inviter_name        text (o)        -- organisation inviter name
organisation_name   text (o)        -- organisation name

suggestions         text[]          -- fleep address suggestions
country_code        text            -- ISO 3166-1 alpha-2 country code suggestion (based on IP address)

account/set_flag

URL: https://fleep.io/api/account/set_flag

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

Input:

client_flag         text                - name of the flag to set or clear
bool_value          boolean = True      - clear given flag from account

Output:

account/smtp/configure

URL: https://fleep.io/api/account/smtp/configure

Input::

smtp_id uuid –

smtp_username text = None – smtp_password text = None – smtp_host text = None – smtp_port bigint = None – set to -1 to remove

is_removed boolean = None – set True to remove is_default boolean = None – set True to set as default

Output:

stream               list              --  list of SMTPInfo records

:ref:`SMTPInfo <info/smtpinfo>`

account/smtp/list

URL: https://fleep.io/api/account/smtp/list

Input::
None

Output:

stream               list              --  list of all SMTPInfo records

:ref:`SMTPInfo <info/smtpinfo>`

account/smtp/store

URL: https://fleep.io/api/account/smtp/store

Input::

smtp_address text – smtp_username text – smtp_password text – smtp_host text – smtp_port bigint = None – smtp_connection text = None – ‘ssl’/’starttls’

is_default boolean = None – Should it be set default
– if passes validation. – True by deafult.
Output::
SMTPInfo

account/sync_pinboard

URL: https://fleep.io/api/account/sync_pinboard

Sync taskboard.

Input::
conversation_id uuid pin_weight float = null pin_limit int = 30

Output:

stream             list           - List of message records

account/sync_taskboard

URL: https://fleep.io/api/account/sync_taskboard

Sync taskboard.

Input:

conversation_id    uuid
section_id         uuid
task_weight        float = null   - task weight from cursor if provided
task_limit         int = 30       - tasks to sync in one batch (between 1 and 100)

Output:

stream             list           - List of message records

account/trello/board/list

URL: https://fleep.io/api/account/trello/board/list

Input::

external_account_id uuid - id of the external account (see ExternalAccountInfo)

mk_permission_type text - type of permissions that external account has granted to Fleep
create_hook

Output:

record                  record      - account - email, external_account_id; boards - list of Trello boards

ExternalAccountInfo:

account/unsubscribe

URL: https://fleep.io/api/account/unsubscribe

Unsubscribe.

Input:

notification_id     text

Output:

None

avatar/delete

URL: https://fleep.io/api/avatar/delete

Delete current avatar.

Input:

None

Output:

None

avatar/upload

URL: https://fleep.io/api/avatar/upload

Upload avatar

Optional URL arguments:

ticket=XXX Access ticket _method=PUT This POST is actually PUT
PUT:
Content-Type, Content-Disposition are taken from main header

Output:

file_id
name
size