WApi Interface

Version: 1.2
Minimum supported version: 1.0
Code version: 7.18.4

Overview

The WApi api can be used through various protocols, in a synchronous or a asynchronous way.

Http request usage:

The usage mode is synchronous.

The WApi web service can be accessed using that url: https://api.wimi.pro.

WApi has to be called in POST mode. The body of the request contains the WApi input message (json format).
The body of the response contains the WApi response (json format).

The HTTP status code returned by the WApi is always 200. Responses errors must be extracted from the response message (body of the response)


Format description

The request and response messages are based on the same format.

Login request example:

{
    "header": {
        "target": "auth.user.login",
        "identification": {
            "account_name": "myaccount"
        },
        "auth": {
            "login": "firstname.lastname@domain.com",
            "password": "mypassword"
        },
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "a key that can be used to map the response with the request in async mode"
    },
    "body": {
        "data": null
    }
}

Login response example:

{
    "header": {
        "target": "auth.user.login.info",
        "identification": {
            "account_name": "myaccount"
        },
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "a key that can be used to map the response with the request in async mode",
        "token": "MTU0MDAw:MOB--202545756bd71499f9"
    },
    "body": {
            ...
        }
    }
}

So, the response target is the request target + ".info".
The "msg_key" of the response is the same as the request "msg_key".

Globally speaking, the response header is the same as the request header with some adjustments.

The Header format is generic (common to all request / responses).
The Body format is specific to each target - however the error management is generic

Header fields

target

(string) - Used to identify the WApi function called

identification

(optional object) - Used to provide the ids of the various objects used by the function call - the listed entries are specific to the target being called.

"identification": {
    "account_id": 19472,
    "user_id": 154031,
    "project_id": 131213
    }

auth

(optional object) - Used to provide user authentication

  • login: (string) user login
  • password: (string) user password
"auth": {
    "login": "firstname.lastname@domain.com",
    "password": "mypassword"
}
                    

token

(optional string) - Used to provide the session token (returned by auth.user.login)

api_version

(string) - Api version used

msg_key

(string) - Message key also returned in the message response

output_format

(optional object) - used to provide output formatting parameters:

  • populate_http_status_code: (bool) used to indicate that the http status code must be returned when the request is made through http. By default, the http status code is always 200
"output_format": {
    "populate_http_status_code": true
}

debug

(optional object) - used to provide special debugging parameters:

  • indent_output: (bool) used to turn on json pretty print format in the response message
"debug": {
    "indent_output": true
}

Body fields

data

(optional object) - Used in the request and response WApi messages.
The format is specific to each target.

error

(optional object) - Only found in response WApi messages.

  • id: (int) id of the error (based on the closest http status code)
  • str: (string) string associated to the id (for bettre readability)
  • debug_msg: (optional string) Additional debug data
  • detail_id: (optional int) error sub type
  • detail_str: (optional string) string associated to the error sub type
"error": {
    "id": 401,
    "str": "Unauthorized",
    "debug_msg": "account not found: myaccount",
    "detail_id": 1022,
    "detail_str": "invalid_account"
}

Contact

If you are having issues using our Api, contact us: support@wimi.pro

Actions List

auth.user.BackupUserLogin Used to login the backup user and retrieve an access token
auth.user.GetSessionToken Consumes a consumable session token to get a permanent one
auth.user.Login Used to login a user and retrieve an access token
auth.user.Logout
activity.event.ClearUnreadCount Clear the activity unread count
activity.event.ExportAsCSV export the list of activity events in a CSV file
activity.event.GetList Get a list of activity events
activity.event.GetNextList Ask for the next X results from events
activity.event.GetNotifications Get a list of activity events notified for the contexted user
activity.event.GetUnreadCount Get unread event count by projects
activity.event.NewEvent Used to generate push message
activity.event.NewEventList Used to generate push message
calendar.event.AddComment Add a comment to a calendar event
calendar.event.AddExternalAttachment Attach an external file to a calendar event
calendar.event.AddExternalAttachmentFromTemplate Attach an external file to a calendar event, from a template
calendar.event.AddExternalParticipants Add external participant for a specific event
calendar.event.AddSubscriptionLink Add user to subscription agenda list, it will create token if it not already exist
calendar.event.AddTag Add a tag to a Calendar Event
calendar.event.AddUnifiedSubscriptionLink Add user to subscription agenda list, it will create token if it not already exist on unified view
calendar.event.AddWimiAttachment Attach a wimi file to a calendar event
calendar.event.ChangeInviteStatus Change Status of Agenda Event Participant. Accept / Refuse invite to an event
calendar.event.ConversationArchive Archive a conversation
calendar.event.ConversationClearUnseen Clear unseen count for conversation
calendar.event.ConversationSetSilent Set silent for conversation
calendar.event.CopyEventList
calendar.event.Create Create a calendar event
calendar.event.DeleteComment Delete a calendar event comment
calendar.event.DeleteSubscription Get calendar subscription link for unified projects
calendar.event.DeleteSubscriptionUnified Get calendar subscription link for unified projects
calendar.event.DownloadAttachment Download a calendar event attachment
calendar.event.EditComment Edit a comment of a calendar event
calendar.event.GenerateWOGeneralFile create an external file to a calendar event
calendar.event.Get Get the details of a calendar events
calendar.event.GetAttachmentList get the list of files attached to a calendar event
calendar.event.GetComments Get teh comments of a calendar event
calendar.event.GetDownloadInviteLink Download the ics for a specific event
calendar.event.GetExternalParticipants Get external participant for a specific event
calendar.event.GetList Get a list of events
calendar.event.GetListUnified Get a list of events for unified calendars
calendar.event.GetSubscriptionLink Get a calendar subscription link
calendar.event.GetUnifiedSubscriptionLink Get calendar subscription link for unified projects
calendar.event.GetUserSubscriptionList Get calendar subscription link for projects
calendar.event.GetUserSubscriptionListUnified Get calendar subscription link for unified calendar
calendar.event.LinkTag Link a tag to a calendar event
calendar.event.PreviewAttachment Request attachment preview
calendar.event.Remove Delete a calendar event
calendar.event.RemoveExternalAttachment remove an external attachment from the calendar
calendar.event.RemoveExternalParticipants Remove external participant for a specific event
calendar.event.RemoveRecurrenceOccurrence Delete a recurrence occurrence
calendar.event.RemoveTag Remove a tag in a task
calendar.event.RemoveWimiAttachment remove a wimi attachment from the calendar
calendar.event.ToggleCommentReaction Toggle a reaction to a comment
calendar.event.Update Update a calendar event - only the provided data are updated.
calendar.event.UpdateProject Move a calendar event from one project to another
chat.chat.AddAttachment Attach a file to a chat
chat.chat.AddInternalAttachment Attach a internal file to a chat
chat.chat.AddInternalAttachments
chat.chat.AddMembers Add members to a chat
chat.chat.AddUsers Add users to a chat
chat.chat.CanceledTyping Send a notification that the user canceled typing
chat.chat.ClearUnseen Clear unseen count for chat
chat.chat.Create Create a group chat
chat.chat.CreateChannel Create channel chat
chat.chat.DeleteMessage Delete a message
chat.chat.Disable Disable a chat for a user
chat.chat.DownloadAttachment Download a chat attachment
chat.chat.EditMessage Edit a message
chat.chat.EditName Edit a chat name
chat.chat.FavoriteMessage Favorite a message
chat.chat.GetAttachmentList Get attachment list
chat.chat.GetChat Get chat
chat.chat.GetFavorites Get favorite list
chat.chat.GetLinks Get shared links in a chat
chat.chat.GetList Get chat list
chat.chat.GetMessageBeforeAfter Search through chat messages
chat.chat.LoadMessages Get chat messages from offset of given message id, until limit
chat.chat.PostMessage Post message to chat
chat.chat.PreviewAttachment Request attachment preview
chat.chat.RemoveMembers Remove members from a chat
chat.chat.RemoveUsers Remove users from a chat
chat.chat.Search Search through chat messages
chat.chat.SetMessageIntegrationAttachment Set the integration attachment for a message
chat.chat.SetSilent Set silent for chat
chat.chat.StartedTyping Send a notification that the user is typing
chat.chat.UnfavoriteMessage Unfavorite a message
chat.chat.UpdateGroupChatProfilePicture
chat.message.AddMessageReaction Add a reaction for a message
chat.message.DeleteMessageReaction Delete a reaction for a message
comment.comment.GetCommentsForItem Get a specific user commented item
comment.comment.GetUserCommentedItems Get user commented items
communication.air.CreatePersistentRoom create a persistent room
communication.air.GetPersistentRoom Get persistent airtime room
communication.air.ScheduleCall Schedule an AirTime call
communication.chat.ConversationArchive
communication.chat.ConversationArchiveList
communication.chat.ConversationClearUnseen
communication.chat.ConversationCommentAdded
communication.chat.ConversationCommentEdited
communication.chat.ConversationCommentReactionToggled
communication.chat.ConversationCommentRemoved
communication.chat.ConversationSetSilent
document.directory.AddComment Add comment to a directory
document.directory.AddLink Add link to directory
document.directory.AddMembersToDir Add members to dir
document.directory.ConversationArchive Archive a conversation
document.directory.ConversationClearUnseen Clear unseen count for conversation
document.directory.ConversationSetSilent Set silent for conversation
document.directory.Copy Copy a directory elsewhere
document.directory.CopyList Copy a list of directory elsewhere
document.directory.Create Creates a directory
document.directory.CreateDirectoryTree Creates a directory tree when uploading a folder
document.directory.DeleteComment Delete a directory comment
document.directory.DeniedList Get the list of denied directories for a user
document.directory.EditComment Edit a comment of a directory
document.directory.EditMembersAccessToDirectories Edits members access on one or several directories
document.directory.EditName Edits the name of a directory
document.directory.Get Get a directory only given its id
document.directory.GetComments Get comments of a directory
document.directory.GetDirectoryUsers Get list of all users having access to given directory
document.directory.GetMembersAccess Get users access of a dir
document.directory.GetReadOnlyStateForUser Get the read only state of the directory for the current user
document.directory.LinkPathInfo Get file path info
document.directory.Move Move directories to a folder
document.directory.MoveLink Move links from one directory to another
document.directory.MoveToGarbageCollector Permanently delete one or more directories
document.directory.MoveToTrash Delete one or more directories
document.directory.PathInfo Get directory path info
document.directory.PromoteToProject Creates a project from a directory
document.directory.RemoveMembersFromDir Remove members from dir
document.directory.RemoveProperty Remove a property from a directory
document.directory.Restore Restore one or more directories from trash
document.directory.SetDirectoryDefault Set default access on a directory
document.directory.SetPropertyValue
document.directory.ToggleCommentReaction Toggle a reaction to a comment
document.entry.DirList List folders found in a folder
document.entry.GetProjectTree Get flat tree for project
document.entry.GetSharingZipperFileList
document.entry.GetZipperFileList
document.entry.List List the files and folders found in a folder
document.entry.ListServiceEntries List the service entries of a folder
document.entry.TrashList List the files, the link and folders found in the trash
document.file.ActivateSharing Activate sharing on one file
document.file.AddComment Add a file comment
document.file.AddTag Add a tag on a file
document.file.AttachmentIntoDoc Take an attachment from chat or task and add it to the document module
document.file.CheckConflict check a file name conflict
document.file.CheckConflicts Check conflicts of a specific name in a folder
document.file.ConversationArchive Archive a conversation
document.file.ConversationClearUnseen Clear unseen count for conversation
document.file.ConversationSetSilent Set silent for conversation
document.file.Copy Copy a file elsewhere
document.file.CopyList Copy a list of file elsewhere
document.file.CreateFromTemplate Create a file from a given template
document.file.DeactivateSharing Deactivate sharing on one file
document.file.DeleteComment Delete a file comment
document.file.Download
document.file.DownloadForPreviewInternal
document.file.EditComment Edit a file comment
document.file.EditDescription Edit a file description
document.file.EditName Edits the name of a file
document.file.GetComments Get the comments of a file
document.file.GetDownloadToken
document.file.GetEvents Get the historical events of a file
document.file.GetIPTCMetadata Get IPTC data for a file
document.file.GetMetaDataFields Get all metadata fields for account
document.file.GetOnlineEditionFileToken Get file token for editing file online using only office
document.file.GetProperties get the properties of a file
document.file.GetVersions Get a file's versions list
document.file.GuestLink Get guest link of a file - DEPRECATED - use ActivateSharing
document.file.IsVersionOf Checks if a version of a file is on the server (by md5)
document.file.LinkTag Link a tag to a file
document.file.Lock Used to lock a file.
document.file.Move Move files to a folder
document.file.MoveToGarbageCollector Permanently delete one or more files
document.file.MoveToTrash Delete one or more files
document.file.NotifyOpen Warn users that a specific file is being opened
document.file.PathInfo Get file path info
document.file.RemoveProperty Remove a property from a file
document.file.RemoveTag Remove a tag in a file
document.file.RemoveTagByLabel Remove a tag in a file using the label
document.file.Restore Restore one or more files
document.file.SetPropertyValue Set a property to a file
document.file.ToggleCommentReaction Toggle a reaction to a comment
document.file.Unlock Used to unlock a file.
document.file.Unversion Unversion one file
document.file.Upload
document.general_file.GetDownloadToken
document.general_file.GetOnlineEditionGeneralFileToken Get file token for editing external file online using only office
document.service.BringBack Bring backs a service file back to the wimi (and removes the .html in wimi if it succeeds). Only works with google ATM.
document.service.CheckToken Check service token
document.service.Download Directly download the document from the service. Only google is supported right now.
document.service.Edit Edit (and upload) a file to service. Only google is supported right now.
document.service.GetEntries Get service entries
document.service.ImportEntries Import service entries
document.service.LinkDirs Link directories from service entries
document.sharing.Activate Activate sharing on one directory
document.sharing.AllowInvisibleSub Allow invisible subdirectories on a shared folder
document.sharing.AllowUpload Allow upload on a given shared folder
document.sharing.Deactivate Deactivate sharing on one directory
document.sharing.DisallowInvisibleSub Disallow invisible subs on a shared folder
document.sharing.DisallowUpload Disallow upload on a given shared folder
document.sharing.ExportAsCsv Activate sharing on one directory
document.sharing.RemovePassword Remove a password of a shared folder
document.sharing.SetExpirationDate Set an expiration date for an item
document.sharing.SetPassword Set a password for an item
document.signature.DownloadAttachment Download a chat attachment
document.signature.PreviewAttachment Request attachment preview
document.signature.SignatureFromExternalFile Create a file signature from an external file
document.signature.SignatureFromInternalFile Create a Signature from an internal (already existent in account) file
document.template.AddTag Add a tag on a general file template
document.template.CreateFromExternalFile Create a file template from an external file
document.template.CreateFromInternalFile
document.template.LinkTag Link tag to template
document.template.ListForAccount List file templates of account
document.template.PreviewTemplate Request template preview
document.template.RemoveTag Remove tag from template
document.template.Restore Restore trashed file template
document.template.Trash Put file template to trash
document.template.UpdateDescription Update file template description
document.template.UpdateName Update file template name
document.trash.EmptyTrash Empty the trash
document.trash.List List the files found in the trash given a set of filters
document.trash.ListDirectories List the folders found in the trash given a set of filters
document.trash.ListLinks List the links found in the trash given a set of filters
document.trash.RestoreDirectories Restore one or more directories
document.trash.RestoreFile Restore one or more files
document.trash.RestoreLinks Restore one or more links
document.validation.AddValidatorsToRequest Add validators to a doc validation request
document.validation.CreateRequest
document.validation.EditRequestDescription Edit doc validation request description
document.validation.ExportAccountValidationssAsXLS Exports all document validations of the account as XLS
document.validation.ExportMyValidationAsXLS Exports all document validation the calling user has access to as XLS
document.validation.ListRequests List all doc validation requests for that user
document.validation.ListRequestsAsRequester List all doc validation requests associated to a requester
document.validation.ListRequestsAsValidator List all doc validation requests associated to a validator
document.validation.ListResponses List all doc validation responses for a user
document.validation.RemindValidator send a reminder email to a validator
document.validation.RemoveRequest Remove a doc validation request
document.validation.RemoveValidatorsFromRequest Remove validators from a doc validation request
document.validation.ResetResponseStatus Reset a response for a validator
document.validation.UpdateRequestExpiryDate Update expiry date of a doc validation request
document.validation.UpdateRequestStatus Update status of a doc validation request
document.validation.UpdateResponseStatus Update a response for a validator
document.validation.exportMyRequestsAsXLS Exports all document requests made by the calling user as XLS
gantt.gantt.AddGanttLink Add a gantt link between two Wimi items
gantt.gantt.AddGanttLinkBetweenProjects Add a gantt link between two projects
gantt.gantt.AddList Add a list to gantt view
gantt.gantt.BatchAddList Add lists to gantt view
gantt.gantt.BatchRemoveList Batch remove lists from gantt view
gantt.gantt.GetGanttLinks Get all gantt links (between tasks or between lists) for a project
gantt.gantt.GetGanttProjectIds Get the project id list of all project that are in gantt
gantt.gantt.GetUnifiedGanttLinks Get all gantt links (between tasks or between lists) for all the project of the account
gantt.gantt.RemoveGanttLink Remove a gantt link between two items
gantt.gantt.RemoveGanttLinkBetweenProjects Remove a gantt link between two items
gantt.gantt.RemoveList Remove a list from gantt view
gantt.gantt.ResetPlanning Reset the gantt planning for the tasks list and tasks
link.link.AddComment Add a link comment
link.link.AddTag Add a tag on a link
link.link.ConversationArchive Archive a conversation
link.link.ConversationClearUnseen Clear unseen count for conversation
link.link.ConversationSetSilent Set silent for conversation
link.link.CopyLink Copy links from one directory into another
link.link.DeleteComment Delete a link comment
link.link.Edit Edit url and/or title of link
link.link.EditComment Edit a link comment
link.link.GetComments Get comments of a link
link.link.GetEvents Get the historical events of a link
link.link.LinkTag Link a tag to a link
link.link.PathInfo Get link path info
link.link.RemoveTag Remove a tag in a link
link.link.RemoveTagByLabel Remove a tag in a link using the label
link.link.RestoreLink Restore link from trash
link.link.ToggleCommentReaction Toggle a reaction to a comment
link.link.TrashLink Put a list of links to trash
mail.client.CreateGandiClient Create a Gandi Client for the specified wimi account
mail.domain.BuyDomain Buy a gandi domain
mail.domain.CreateMailbox Create a mailbox on the current account main domain
mail.domain.EditDomainAutoRenew Edit a domain auto renew status
mail.domain.FetchDomainAvailability Query gandi with domain name to check a list of available domain & their data (prices)
mail.domain.FetchDomainData Fetch domain metadata
mail.domain.GetAccountDomains Get all the gandi domains of the given account
mail.domain.SynchronizeDomains Synchronize domains from GANDI & creates them in WIMI if needed
mail.mailbox.ActivateResponder Activate the automatic responder for the given mailbox
mail.mailbox.AddOwnersToMailbox Insert given users as owners of the given gandi mailbox
mail.mailbox.CreateMailbox Create a mailbox on the current account main domain
mail.mailbox.DeleteMailbox Delete a mailbox
mail.mailbox.FetchDomainMailboxes Fetch all the mailboxes associated to the account's main domain. Implemented in node3 async mode
mail.mailbox.FetchMailboxPackage Get the mailbox package for an account
mail.mailbox.FetchMailboxPackageList Get all the available mailbox packages and the selected one (if any)
mail.mailbox.FetchMailboxesStorage Fetch the quota storage on each mailbox of a domain
mail.mailbox.FetchUserMailboxes Fetch all the mailboxes associated to the current user. Implemented in node3 async mode
mail.mailbox.ImportMailboxesFromCSV Import a csv and create a list of mailboxes
mail.mailbox.PurgeMailbox Purge the given mailbox
mail.mailbox.RemoveOwnersFromMailbox Activate the automatic responder for the given mailbox
mail.mailbox.SetMailboxPackage Set a mailbox package for an account
mail.mailbox.UpdateMailbox
mail.mailbox.UpdateMailboxAliases Update the aliases for a mailbox
mail.mailbox.UpdateMailboxPassword Activate the automatic responder for the given mailbox
mail.webmail.AddWebmailAccount
mail.webmail.DeleteWebmailAccount
mail.webmail.GetConnectedWebmail
mail.webmail.GetWebmailAccountList
mail.webmail.SendWebmailAction
mail.webmail.SetConnectionStatus
mail.webmail.UpdateWebmailAccount
main.account.AcceptUniversignGcu Accept the Universign GCU (General Conditions of Use) for the account.
main.account.ActivateCustomDepartmentList Activate the custom department list; this means the custom list will be used instead of the default one
main.account.ActivateUsers Activate list of users
main.account.AddCreditCard
main.account.AddCredits
main.account.AddCustomDepartmentItem Add a new item to account custom department list
main.account.AddUser Add a user
main.account.BatchUpdateUsersRole Batch update role for user list
main.account.DeactivateCustomDepartmentList Deactivate the custom department list; this means the default list will be used instead of the custom one
main.account.DeactivateUsers Deactivate list of users
main.account.DeleteAccount Delete the account
main.account.DeleteCustomDepartmentItem Delete a custom item
main.account.DeleteUsers Delete list of users permanently
main.account.EditCategory Edit a category
main.account.EditUser Edit a user
main.account.ExportProjectsDiskUsageAsCsv Export the projects disk usage for the account as a CSV file
main.account.ExportUsers Export users in a file
main.account.ExportUsersRights Export users rights in a file
main.account.GenerateAPIKey Generate an API Key for the current account
main.account.Get Get account info
main.account.GetAccountExternalInfo Get external information for an account
main.account.GetAccountPayingServices Get the account paying services (available & selected with metadata)
main.account.GetAccountSignaturePackages Get the account signature package list
main.account.GetActivityRelatedRequestList Get wapi routes that should update the activity unread counter
main.account.GetAllAvailableUsers Get all available users. Which mean a status will be returned.
main.account.GetBillingInfo
main.account.GetCalendars Get the calendars of a user
main.account.GetCategories Get categories of a user
main.account.GetCountryStateCode Retrieve big object containing country & state ISO-3166-1&2 code
main.account.GetCurrentSignaturePackage Get the current signature package
main.account.GetCustomDepartmentList Get the account custom department list
main.account.GetDepartmentList Get the list of department for the account
main.account.GetDocumentNodeCount Return document nodes count
main.account.GetGAppsUsers Get gapps users and format the output to correspond the ones of Wimi
main.account.GetListOfUsersSharingSameProjects Get list of users sharing the same projects
main.account.GetMemberListProjectsAuth Get list of privileges on projects for a member list
main.account.GetMemberProjectsAuth Get list of privileges on projects for a member
main.account.GetProject Get a user project
main.account.GetProjectTemplates Get the project templates for that account
main.account.GetProjects Get projects of a user
main.account.GetProjectsStats Get projects stats for user available projects
main.account.GetServiceUsers Get the users of the given service and format the output to correspond the ones of Wimi
main.account.GetSettings Get settings for the account
main.account.GetTutorialInfo Return the necessary info to display the welcome tutorial
main.account.GetUniversignGcuAcceptanceStatus Get the status of Universign GCU (General Conditions of Use) acceptance for the requested account
main.account.GetUser Get a user
main.account.GetUserProjectsAuth Get list of privileges on projects for a user
main.account.GetUsers Get all users
main.account.ImportGAppsUser Import a gapps user in wimi
main.account.ImportUsersFromCSV Import users from csv
main.account.MoveCustomDepartmentItem Move a custom item to given position
main.account.PayingServicesAddEntity Add an entity of debit_type to the selected paying service
main.account.RegenerateGeneralPassword Regenerate the password of the Wimi Backup user of this account
main.account.RemoveAPIKey Remove an API Key for the current account
main.account.RemoveCreditCard
main.account.SelfDeactivate Deactivate the current user
main.account.SetBillingInfo Set billing info of account
main.account.SetOnBoardingInfo Set the on boarding info for the account
main.account.SetSettings Set settings for the account
main.account.SetUISetting Customization - set ui settings
main.account.SetWelcomeActivity Set welcome activity
main.account.ShouldPerformPayment
main.account.SubscribeToSignaturePackage Subscribe to a signature package
main.account.ToggleSupportInterventionAuthorization Toggle support intervention authorization on account
main.account.ToggleThirdPartyService Enable/Disable a third party service for the account
main.account.UnsubscribeToSignaturePackage Subscribe to a signature package
main.account.UpdateCustomDepartmentItem Add a new item to account custom department list
main.appli.GetWebappVersion Get the webapp version
main.group.AddMember Add a member to a group
main.group.AddTag Add a tag on a user group
main.group.BatchAddMembers Batch add members to a group
main.group.Create Create a user group
main.group.Delete Delete a user group
main.group.Edit Edit a user group
main.group.EditGroupCreationUser Edit a group creation user
main.group.LinkTag Link a tag to a group
main.group.List List the user group of this account
main.group.RemoveMember Remove a member from a group
main.group.RemoveTag Remove a tag in a user group
main.group.RemoveTagByLabel Remove a tag in a user group using the label
main.personalizedentry.AddChoice add a choice to a personalized entry of type qcu / qcm
main.personalizedentry.BatchUpdateEntryAccess Insert object access for specified entry (workspace/users)
main.personalizedentry.BatchUpdateEntryProjectAuth change entry access to workspace (module)
main.personalizedentry.Create create a personalized entry
main.personalizedentry.DeleteChoice remove a choice
main.personalizedentry.DeleteEntries Batch delete entries
main.personalizedentry.GetEntryGlobalAccess get workspace / module access of an entry
main.personalizedentry.GetItemEntries Get item entries and their value
main.personalizedentry.GetPersonalizedEntries get a personalized entry
main.personalizedentry.GetPersonalizedEntriesForObject get a personalized entries for users
main.personalizedentry.GetWorkspaceEntryAccess get specific workspace / module access of an entry
main.personalizedentry.MoveChoice Move a choice to another position
main.personalizedentry.MoveEntry Move a choice to another position
main.personalizedentry.RenameChoice add a choice to a personalized entry of type qcu / qcm
main.personalizedentry.SetEntryValue Set value for the specified entry
main.personalizedentry.UpdateName Update name of an entry
main.project.ActivateModules Activate modules on a project
main.project.AddTag Add a tag on a project
main.project.Archive Archive a project
main.project.BatchSetUsersAuth Set the auth on a project for a list of users
main.project.Create
main.project.CreateFromTemplate Create a project given a template
main.project.DeactivateModules Deactivate modules on a project
main.project.Delete Delete a project definitely
main.project.GetProjectTagCountInFamily
main.project.GetTemplateList Get list of templates for this account / user
main.project.GetUsersAuth Get list of all users auth on that project
main.project.GetUsersList Get list of all users in a project (via user_id)
main.project.IsServiceAvailableForProject Check whether project has specified paying service enabled. adds the access if add_paying_service is set to true
main.project.LinkTag Link a tag to a project
main.project.LockProjectTree Lock a project tree
main.project.RemoveTag Remove a tag in a project
main.project.RemoveTagByLabel Remove a tag in a project using the label
main.project.RemoveTagFamilyRestriction Remove tag family restriction
main.project.RemoveUserGroups Removes user groups from a project
main.project.RemoveUsers Removes users from a project
main.project.ReplaceUser Replace a user in another in a project
main.project.Restore Unarchive a project
main.project.SetDriveSync Enable/Disable the drive synchronisation for all users
main.project.SetMemberAuth Set the member auth on a project
main.project.SetTagFamilyRestriction Set tag family restriction
main.project.SetUserAuth Set the user auth on a project
main.project.SetUserGroupAuth Set the user group auth on a project
main.project.UnlockProjectTree Unlock a project tree
main.project.Update
main.project.UpdateDefaultModule Update default module
main.saml.CreateServiceToken Create a token that can be used by an external service to create a limited access token for that user
main.saml.GetAccountList Get a list of account associated to the user linked to the given access token
main.search.AddRecentSearch Add search to recent search user history
main.search.ClearSearchHistory Clear search history for specified user
main.search.GetUserRecentSearch Get user recent search history
main.search.Search Search items in the wimi with a query
main.search.SearchDocument
main.search.SearchDocumentsWithMetadata
main.search.SearchMore Ask for the next X results from Wimi's global search
main.search.SearchPersonalizedEntries Search items in the wimi with a query
main.search.SearchProjects Search through projects in the wimi with a query
main.session.Load Load some info about the session
main.session.LoadExtra Load some info about the session
main.session.LoadProjects Getting all projects the user has access to and their information
main.session.LoadUsers Getting all users the user can see and their information
main.session.Ping Ping
main.tag.AddTagsToFamilies Add a list of tags to a list of tag families
main.tag.BatchMergeTags merge several tags into another
main.tag.BatchRemove remove several tags
main.tag.ChangeColor Change the color of a tag
main.tag.Create create a tag
main.tag.CreateFamily create a family tag
main.tag.Get get a tag
main.tag.GetAll get all tags for this account
main.tag.GetByLabel get a tag by its label
main.tag.GetFamilyTags get a family tag
main.tag.GetStats
main.tag.ImportFromCSV Import tags from csv
main.tag.MergeTags merge one tag into another
main.tag.Remove remove a tag (globally)
main.tag.RemoveFamilyTag remove a family tag tag
main.tag.RemoveTagsFromFamily Remove a list of tags from a family
main.tag.Rename
main.tag.UpdateFamily update a family tag
main.user.AddTag Add a tag on a user
main.user.BatchLinkTag Link a tag to a list of user
main.user.BatchRemoveTag Remove a tag in a list of users
main.user.BatchUpdateProperty
main.user.CreateLimitedTokenForService Create a token with restricted accesses for a specific service
main.user.CreateServiceToken Create a token that can be used by an external service to create a limited access token for that user
main.user.DeleteServiceToken Delete a user service token
main.user.EditAvatar Update the avatar of a user
main.user.GetCaldavSyncSettings Get Caldav synchronization settings
main.user.GetGlobalStatus Get global status of a user.
main.user.GetKnownUsersId Return the id list of all the users knows
main.user.GetNotificationSettings get user notification settings (enabled/disabled)
main.user.GetRelativeUsersId Return the id list of all the users that have at least one project in common with the acting user
main.user.GetSelf Get self user
main.user.GetUserServicesInfo Get third party services info for a user
main.user.LinkTag Link a tag to a user
main.user.ListProperties Get all the user properties
main.user.RemoveProperty Remove a property for the user
main.user.RemoveTag Remove a tag in a user
main.user.RemoveTagByLabel Remove a tag in a user using the label
main.user.RevokeService Revoke a third party service for a user
main.user.SetNotificationSettings set user notification settings (enabled/disabled)
main.user.SetProjectCaldavSync Set Caldav synchronization for a project
main.user.SetStatus Set the status of the user. Status is linked to the session_id.
main.user.SetUserLanguage Set a user language
main.user.SetUserStatus Set the status of the user.
main.user.Update Update the user information
main.user.UpdateProperty
main.util.GetSpecificTrad Get specific trad in specific lang
meeting.meeting.Add Add a meeting
meeting.meeting.AddDates Add dates to a meeting
meeting.meeting.AddExternalParticipants Add external participants to a meeting
meeting.meeting.AddInternalParticipants Add internal participants to a meeting
meeting.meeting.Delete Delete a meeting
meeting.meeting.Edit Edit a meeting
meeting.meeting.FixDate Fix a date
meeting.meeting.Get Get a meeting
meeting.meeting.GetList Get meetings
meeting.meeting.RemoveParticipants Remove participants from a meeting
meeting.meeting.UnfixDate Unfix a date
meeting.meeting.UpdateStatus Add external users to a meeting
poll.poll.Vote Vote for a poll
reporting.task.Burndown Get burndown
reporting.task.Load Load all stats
reporting.task.Performance Get performance
reporting.task.Status Get status
reporting.task.Tags Get tags
reporting.task.Workload Get workload
sharing.sharing.Download Download a file from a sharing folder
sharing.sharing.DownloadFile Download a file from a sharing file
sharing.sharing.DownloadFileFromSharedFolder Download a file from a shared folder
sharing.sharing.Folder List entries of folder
sharing.sharing.Load Get information required to load sharing doc page
sharing.sharing.LoadFile Get information required to load file sharing page
sharing.sharing.RequestLinkPreview
sharing.sharing.Upload Upload a file via a sharing folder
social.community.Archive Archive a community
social.community.Create Create a community
social.community.Delete Delete a community
social.community.GetArchivedList Get the list of archived community for a user
social.community.GetAuthList Get a list of community member auth
social.community.GetDiscoveryList Get the list of community for a user to discover
social.community.GetFavoritePostList Get the list of favorite post
social.community.GetList Get the list of community for a user
social.community.GetPinnedPostList Get a list of pinned post for a community
social.community.GetPostList Get a list of post
social.community.GetRecentPostList Get a list of recent post for a community list
social.community.GetUnseenActivity Get a list of unseen activity
social.community.PublishPost Publish into a community
social.community.RemoveMember Remove a member from the community
social.community.ResubscribeMember Force subscription of a member from the community
social.community.Subscribe Subscribe to a community
social.community.ToggleFavorite Toggle favorite for a community
social.community.Unarchive Unarchive a community
social.community.Unsubscribe Unsubscribe from a community
social.community.Update Update a community
social.community.UpdateAuthList Update (add or create) the list of auth for a community
social.community.UpdateAvatar Update a community avatar
social.community.UpdateBackground Update a community background cover
social.community.UpdatePost Update a post
social.post.AddExternalAttachment Attach an external file to a post
social.post.ClearUnseen Flag posts as seen
social.post.DeleteComment Delete a comment on a post
social.post.DeletePost Delete a post
social.post.DownloadAttachment Download a post attachment
social.post.EditComment Edit a comment on a post
social.post.GetPostReaders
social.post.PreviewAttachment Request attachment preview
social.post.PublishComment Publish a comment on a post
social.post.RemoveExternalAttachment Remove an external attachment from a community post
social.post.SetCommentIntegrationAttachment Set the integration attachment for a post comment
social.post.SetIntegrationAttachment Set the integration attachment for a post
social.post.ToggleCommentReaction Toggle a reaction to a comment
social.post.ToggleCommentsEnabled Toggle comments enabled for a community post
social.post.ToggleFavorite Toggle favorite for a community post
social.post.TogglePinned Toggle pinned for a community post
social.post.ToggleReaction Toggle a reaction to a post
task.filter.Add Adds a filter on tasks to the project or on unified tasks
task.filter.Apply Apply a filter on the tasks of the given projects
task.filter.Delete Delete a filter
task.filter.Edit Edits a filter on tasks
task.filter.Get Get a tasks filter
task.filter.List List tasks filters
task.filter.ListUnified List unified tasks filters
task.subtask.AddOwners Add Owner to a subtask
task.subtask.ChangeStatus Change status of a subtask
task.subtask.Create Create a subtask for the given task
task.subtask.Delete Delete a subtask
task.subtask.Move Move a subtask to another position (and/or task)
task.subtask.RemoveOwners Add Owner to a subtask
task.subtask.Update Update a subtask
task.task.AddBatchOwner Get all tasks of a list
task.task.AddComment Add a comment to a task
task.task.AddExternalAttachment Attach an external file to a task
task.task.AddExternalAttachmentFromTemplate Attach an external file to a task, from a template
task.task.AddReminder Add a reminder for a task
task.task.AddTag Add a tag in a task
task.task.AddWimiAttachment Attach a wimi file to a task
task.task.BatchDelete Delete a batch of tasks
task.task.BatchDuplicate Copy a batch of tasks
task.task.BatchLinkTag Link a tag to a list of tasks
task.task.BatchMove Move a batch of tasks to a position
task.task.BatchMoveAfter Move a batch of tasks after another
task.task.BatchRemoveTag Remove a tag in list of tasks
task.task.ChangeStatus Change the status of a given task
task.task.ChangeStatusBulk Change the status of several tasks
task.task.ConversationArchive Archive conversation
task.task.ConversationClearUnseen Clear unseen count for conversation
task.task.ConversationSetSilent Set silent for conversation
task.task.Create Create a task
task.task.Delete Delete a task
task.task.DeleteComment Delete a task comment
task.task.DeleteDates Delete Dates from a Task
task.task.DisableRecurrence Disable a recurrence for a task
task.task.DownloadAttachment Attach a file to a task
task.task.Duplicate Copy a task
task.task.EditComment Edit a comment of a task
task.task.Follow Add self as follower to this task
task.task.GenerateNextOccurrence Generate the next occurrence of a task
task.task.GenerateWOGeneralFile create an external file to a task
task.task.Get Get a task with all its data
task.task.GetAll Get all tasks of a list
task.task.GetAttachmentList Get the list of files attached to a task
task.task.GetNbNotCompletedForProject Get the total amount of not completed tasks for the given project
task.task.History Get a task history
task.task.LinkTag Link a tag to a task
task.task.Move Move a task to new position
task.task.MoveAfter Move a task after another
task.task.PreviewAttachment Request attachment preview
task.task.Relocate Relocate a task in an other project
task.task.RemoveBatchOwners Get all tasks of a list
task.task.RemoveExternalAttachment remove an external attachment from the task
task.task.RemoveReminder Remove a reminder for a task
task.task.RemoveTag Remove a tag in a task
task.task.RemoveTagByLabel Remove a tag in a task using the label
task.task.RemoveWimiAttachment Remove a wimi attachment from a task
task.task.SendReminder send a reminder to the owners of a task
task.task.SetRecurrence Set or update a recurrence for the given task
task.task.ToggleCommentReaction Toggle a reaction to a comment
task.task.ToggleDefaultOverdueAlert Add or remove the default overdue alert for a task
task.task.Unfollow Remove self as follower from this task
task.task.Update Update a task
task.tlist.AddLink Create a link between 2 lists given a specific relation type
task.tlist.BatchSetHidden Set the tasks lists the user does not want to display
task.tlist.ChangeLine Change line in gantt view
task.tlist.Copy
task.tlist.Create Create a task list
task.tlist.Dashboard Get all necessary data for displaying the tasks module dashboard
task.tlist.DashboardGlobal Get all necessary data for displaying the tasks module dashboard
Same as dashboard but for a user, not a project
task.tlist.Delete Delete a task list
task.tlist.ExportAsCSV Exports all tasks and lists of a project as csv
task.tlist.ExportAsXLS Exports all tasks and lists of a project as XLS
task.tlist.ExportFilteredAsXLS Exports all tasks and lists as csv given filter options
task.tlist.Follow Add self as follower to this list
task.tlist.GetAcceptedTasks Get all Tasks that are accepted
task.tlist.GetAll Returns all tasks lists of a project
task.tlist.GetList Returns a task list with its stats
task.tlist.ImportFromCSV Import tasks and lists from csv
task.tlist.ImportFromXLS Import tasks and lists from xls
task.tlist.Move Move a task list
task.tlist.RemoveLink Remove link between 2 lists
task.tlist.Unfollow Remove self as follower from this list
task.tlist.Update Update a task list
task.tlist.UpdateDates
task.tlist.UpdateExcludeAcceptedTask
task.trash.List List all trashed tasks lists and their tasks (also trashed)

Actions


auth.user.BackupUserLogin

Used to login the backup user and retrieve an access token
The account must be valid and the user must be activated

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int

Output:

  • account_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "auth.user.BackupUserLogin",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

auth.user.GetSessionToken

Consumes a consumable session token to get a permanent one
Will throw and register in bouncer on failure

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int

Body Data:

  • consumable_token - string

Output:

  • token - string

Example:

{
    "header": {
        "target": "auth.user.GetSessionToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345
        }
    },
    "body": {
        "data": {
            "consumable_token": "mylabel1"
        }
    }
}

auth.user.Login

Used to login a user and retrieve an access token
The account must be valid and the user must be activated

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_name - string Optional: ""

Body Data:

  • list_projects - bool Optional: false
  • projects_auth - bool Optional: true
  • projects_stats - bool Optional: false
  • projects_tasks_stats - bool Optional: false
  • projects_users - bool Optional: false
  • manual - bool Optional: false
  • token - string Optional: ""
  • fetch_pwd_sha - bool Optional: false

Output:

  • user - User
  • account - Account
  • projects - LIST of Project - can be null
  • need_update - bool
  • need_double_authentification - bool - can be null

Example:

{
    "header": {
        "target": "auth.user.Login",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {
            "list_projects": true,
            "projects_auth": true,
            "projects_stats": true,
            "projects_tasks_stats": true,
            "projects_users": true,
            "manual": true,
            "token": "some text",
            "fetch_pwd_sha": true
        }
    }
}

auth.user.Logout

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • keep_self - bool Optional: false
  • kill_all - bool Optional: false

Output:

  • success - bool

Example:

{
    "header": {
        "target": "auth.user.Logout",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "keep_self": true,
            "kill_all": true
        }
    }
}

activity.event.ClearUnreadCount

Clear the activity unread count

Push information:

Pushing to: Self
With target: activity.event.ClearUnreadCount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "activity.event.ClearUnreadCount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

activity.event.ExportAsCSV

export the list of activity events in a CSV file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id_list - int list

Body Data:

  • min_date - datetime Optional: null
  • max_date - datetime Optional: null
  • type_list - int list Optional: []
  • csv_delimiter - string Optional: ";"
  • csv_enclosure - string Optional: """
  • user_id_list - int list Optional: []
  • filter - string Optional: ""
  • with_account_event - bool Optional: false

Output:

  • success - bool

Example:

{
    "header": {
        "target": "activity.event.ExportAsCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "type_list": [
                12345,
                12346
            ],
            "csv_delimiter": "some text",
            "csv_enclosure": "some text",
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true
        }
    }
}

activity.event.GetList

Get a list of activity events
Get a list of activity events based on the given parameters

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id_list - int list

Body Data:

  • min_date - datetime Optional: null
  • max_date - datetime Optional: null
  • limit - int Optional: 100
  • offset - int Optional: 0
  • user_id_list - int list Optional: []
  • filter - string Optional: ""
  • with_account_event - bool Optional: false
  • with_deleted_or_archived_projects - bool Optional: false
  • type_list - int list Optional: []

Output:

  • activity_events - LIST of ActivityEvent
  • total_events_count - int

Example:

{
    "header": {
        "target": "activity.event.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "offset": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "with_deleted_or_archived_projects": true,
            "type_list": [
                12345,
                12346
            ]
        }
    }
}

activity.event.GetNextList

Ask for the next X results from events
If we are only displaying the first 100 results, this request should return the next 100 results, etc...

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id_list - int list

Body Data:

  • min_date - datetime Optional: null
  • max_date - datetime Optional: null
  • limit - int Optional: 100
  • user_id_list - int list Optional: []
  • filter - string Optional: ""
  • with_account_event - bool Optional: false
  • type_list - int list Optional: []
  • current_result_count - int
  • with_deleted_or_archived_projects - bool Optional: false

Output:

  • activity_events - LIST of ActivityEvent
  • total_events_count - int

Example:

{
    "header": {
        "target": "activity.event.GetNextList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "min_date": "2016-11-27 17:10:05",
            "max_date": "2016-11-27 17:10:05",
            "limit": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "filter": "some text",
            "with_account_event": true,
            "type_list": [
                12345,
                12346
            ],
            "current_result_count": 12345,
            "with_deleted_or_archived_projects": true
        }
    }
}

activity.event.GetNotifications

Get a list of activity events notified for the contexted user
Get a list of activity events notified for the contexted user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • limit - int Optional: 100

Output:

  • activity_events - LIST of ActivityEvent
  • total_events_count - int
  • total_unread - LIST of struct
    • project_id - int
    • total - int
    • document - int
    • task - int
    • calendar - int
    • meeting - int

Example:

{
    "header": {
        "target": "activity.event.GetNotifications",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "limit": 12345
        }
    }
}

activity.event.GetUnreadCount

Get unread event count by projects

Push information:

Pushing to: Self
With target: activity.event.GetUnreadCount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • limit - int Optional: 100

Output:

  • total_unread - LIST of struct
    • project_id - int
    • total - int
    • document - int
    • task - int
    • calendar - int
    • meeting - int
  • panel_unread - int

Example:

{
    "header": {
        "target": "activity.event.GetUnreadCount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "limit": 12345
        }
    }
}

activity.event.NewEvent

Used to generate push message
Push is sent when we generate an event for an item

Push information:

Pushing to: User list
With target: activity.event.NewEvent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "activity.event.NewEvent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

activity.event.NewEventList

Used to generate push message
Push is sent when we generate a list of event for an item

Push information:

Pushing to: User list
With target: activity.event.NewEventList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "activity.event.NewEventList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.AddComment

Add a comment to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "calendar.event.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

calendar.event.AddExternalAttachment

Attach an external file to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • file_timestamp - string Optional: ""
  • name - string
  • size - int

Output:

Example:

{
    "header": {
        "target": "calendar.event.AddExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "file_timestamp": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

calendar.event.AddExternalAttachmentFromTemplate

Attach an external file to a calendar event, from a template

Push information:

Pushing to: Project users
With target: calendar.event.AddExternalAttachmentFromTemplate
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • file_template_id - int

Body Data:

  • name - string

Output:

Example:

{
    "header": {
        "target": "calendar.event.AddExternalAttachmentFromTemplate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

calendar.event.AddExternalParticipants

Add external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • external_user_list - list

Output:

  • success - bool
  • event_id - int
  • external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.AddExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "external_user_list": [
                {
                    "email": "external_user1@domain.com",
                    "first_name": "first_name1",
                    "last_name": "last_name1"
                },
                {
                    "email": "external_user2@domain.com",
                    "first_name": "first_name2",
                    "last_name": "last_name2"
                }
            ]
        }
    }
}

calendar.event.AddSubscriptionLink

Add user to subscription agenda list, it will create token if it not already exist

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • token - string

Example:

{
    "header": {
        "target": "calendar.event.AddSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.AddTag

Add a tag to a Calendar Event

Push information:

Pushing to: Project users
With target: calendar.event.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • label - string
  • recurrence_id - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "calendar.event.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.AddUnifiedSubscriptionLink

Add user to subscription agenda list, it will create token if it not already exist on unified view

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • token - string

Example:

{
    "header": {
        "target": "calendar.event.AddUnifiedSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.AddWimiAttachment

Attach a wimi file to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.AddWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "calendar.event.AddWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ChangeInviteStatus

Change Status of Agenda Event Participant. Accept / Refuse invite to an event

Push information:

Pushing to: Project users
With target: calendar.event.ChangeInviteStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • recurrence_id - datetime Optional: null

Body Data:

  • status - int

Output:

Example:

{
    "header": {
        "target": "calendar.event.ChangeInviteStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

calendar.event.ConversationArchive

Archive a conversation

Push information:

Pushing to: Self
With target: calendar.event.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

  • success - bool
  • calendar_event_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "calendar.event.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: calendar.event.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

  • success - bool
  • calendar_event_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "calendar.event.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: calendar.event.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • silent - bool
  • silent_until - datetime Optional: null

Output:

  • success - bool
  • calendar_event_id - int
  • user_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "calendar.event.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

calendar.event.CopyEventList

Push information:

Pushing to: Project users
With target: calendar.event.CopyEventList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id_list - int list
  • target_project_id - int Optional: null

Body Data:

  • recurrence_id_list - Array Optional: stdClass Object ( )

Output:

Example:

{
    "header": {
        "target": "calendar.event.CopyEventList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "recurrence_id_list": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

calendar.event.Create

Create a calendar event

Push information:

Pushing to: User list
With target: calendar.event.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • event - struct

Output:

Example:

{
    "header": {
        "target": "calendar.event.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

calendar.event.DeleteComment

Delete a calendar event comment
Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Project users
With target: calendar.event.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • comment_id - int (parameter needs to be owned by api user)

Output:

  • success - bool
  • calendar_event_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "calendar.event.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.DeleteSubscription

Get calendar subscription link for unified projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "calendar.event.DeleteSubscription",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id": 12345
        }
    }
}

calendar.event.DeleteSubscriptionUnified

Get calendar subscription link for unified projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "calendar.event.DeleteSubscriptionUnified",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id": 12345
        }
    }
}

calendar.event.DownloadAttachment

Download a calendar event attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • attachment_id - int
  • calendar_event_id - CalendarEvent

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "calendar.event.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "attachment_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.EditComment

Edit a comment of a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "calendar.event.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

calendar.event.GenerateWOGeneralFile

create an external file to a calendar event

Push information:

Pushing to: User list
With target: calendar.event.GenerateWOGeneralFile
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • name - string
  • file_format - string

Output:

Example:

{
    "header": {
        "target": "calendar.event.GenerateWOGeneralFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "file_format": "some text"
        }
    }
}

calendar.event.Get

Get the details of a calendar events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • recurrence_id - datetime Optional: null

Output:

Example:

{
    "header": {
        "target": "calendar.event.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetAttachmentList

get the list of files attached to a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

Example:

{
    "header": {
        "target": "calendar.event.GetAttachmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetComments

Get teh comments of a calendar event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

Example:

{
    "header": {
        "target": "calendar.event.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetDownloadInviteLink

Download the ics for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

  • success - bool
  • link - string

Example:

{
    "header": {
        "target": "calendar.event.GetDownloadInviteLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetExternalParticipants

Get external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

  • success - bool
  • event_id - int
  • external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.GetExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetList

Get a list of events

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • start_date - datetime Optional: null
  • end_date - datetime Optional: null
  • filters - int list Optional: Array ( [0] => 1 )
  • view_busy - bool Optional: true
  • busy_user_id_list - int list Optional: null
  • view_empty_events - bool Optional: true
  • calendar_event_id_list - int list Optional: []
  • gen_rec_occurrences - bool Optional: true
  • modified_after - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "calendar.event.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27 17:10:05",
            "end_date": "2016-11-27 17:10:05",
            "filters": [
                12345,
                12346
            ],
            "view_busy": true,
            "busy_user_id_list": [
                12345,
                12346
            ],
            "view_empty_events": true,
            "calendar_event_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "modified_after": 12345
        }
    }
}

calendar.event.GetListUnified

Get a list of events for unified calendars

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • start_date - datetime
  • end_date - datetime
  • filters - int list Optional: Array ( [0] => 1 )
  • project_id_list - int list Optional: null
  • user_id_list - int list Optional: null
  • gen_rec_occurrences - bool Optional: true
  • view_empty_events - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "calendar.event.GetListUnified",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27 17:10:05",
            "end_date": "2016-11-27 17:10:05",
            "filters": [
                12345,
                12346
            ],
            "project_id_list": [
                12345,
                12346
            ],
            "user_id_list": [
                12345,
                12346
            ],
            "gen_rec_occurrences": true,
            "view_empty_events": true
        }
    }
}

calendar.event.GetSubscriptionLink

Get a calendar subscription link

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • link - string - can be null

Example:

{
    "header": {
        "target": "calendar.event.GetSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetUnifiedSubscriptionLink

Get calendar subscription link for unified projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • link - string

Example:

{
    "header": {
        "target": "calendar.event.GetUnifiedSubscriptionLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetUserSubscriptionList

Get calendar subscription link for projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • user_id_list - LIST of int

Example:

{
    "header": {
        "target": "calendar.event.GetUserSubscriptionList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.GetUserSubscriptionListUnified

Get calendar subscription link for unified calendar

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • user_id_list - LIST of int

Example:

{
    "header": {
        "target": "calendar.event.GetUserSubscriptionListUnified",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.LinkTag

Link a tag to a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • tag_id - int
  • recurrence_id - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "calendar.event.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • attachment_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • preview_type - string Optional: "default"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • doc_type - string
  • doc_id - int
  • output_type - string

Example:

{
    "header": {
        "target": "calendar.event.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "attachment_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

calendar.event.Remove

Delete a calendar event

Push information:

Pushing to: Project users
With target: calendar.event.Remove
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Output:

  • event_id - int
  • success - bool

Example:

{
    "header": {
        "target": "calendar.event.Remove",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.RemoveExternalAttachment

remove an external attachment from the calendar

Push information:

Pushing to: Project users
With target: calendar.event.RemoveExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • attachment_id - int

Output:

  • success - bool
  • attachment_id - int
  • calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.RemoveExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.RemoveExternalParticipants

Remove external participant for a specific event

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • external_user_id_list - int list

Output:

  • success - bool
  • event_id - int
  • external_participants - LIST of ExternalUser - can be missing

Example:

{
    "header": {
        "target": "calendar.event.RemoveExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "external_user_id_list": [
                12345,
                12346
            ]
        }
    }
}

calendar.event.RemoveRecurrenceOccurrence

Delete a recurrence occurrence

Push information:

Pushing to: Project users
With target: calendar.event.RemoveRecurrenceOccurrence
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • recurrence_id - datetime

Output:

  • event_id - int
  • success - bool
  • recurrence_id - datetime

Example:

{
    "header": {
        "target": "calendar.event.RemoveRecurrenceOccurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "recurrence_id": "2016-11-27 17:10:05"
        }
    }
}

calendar.event.RemoveTag

Remove a tag in a task

Push information:

Pushing to: Project users
With target: calendar.event.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • tag_id - int
  • recurrence_id - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "calendar.event.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.RemoveWimiAttachment

remove a wimi attachment from the calendar

Push information:

Pushing to: Project users
With target: calendar.event.RemoveWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • attachment_id - int

Output:

  • success - bool
  • attachment_id - int
  • calendar_event_id - int

Example:

{
    "header": {
        "target": "calendar.event.RemoveWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

calendar.event.ToggleCommentReaction

Toggle a reaction to a comment

Push information:

Pushing to: Project users
With target: calendar.event.ToggleCommentReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • calendar_event_id - int
  • comment_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "calendar.event.ToggleCommentReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

calendar.event.Update

Update a calendar event - only the provided data are updated.

Push information:

Pushing to: User list
With target: calendar.event.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent

Body Data:

  • event - struct

Output:

  • event - CalendarEvent
  • success - bool
  • updated_fields - LIST of string

Example:

{
    "header": {
        "target": "calendar.event.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "event": "no example yet"
        }
    }
}

calendar.event.UpdateProject

Move a calendar event from one project to another

Push information:

Pushing to: User list
With target: calendar.event.UpdateProject
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Agenda restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • calendar_event_id - CalendarEvent
  • target_project_id - int

Output:

Example:

{
    "header": {
        "target": "calendar.event.UpdateProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "target_project_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddAttachment

Attach a file to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • attachment_title - string Optional: ""
  • attachment_description - string Optional: ""
  • name - string
  • size - int

Output:

Example:

{
    "header": {
        "target": "chat.chat.AddAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "attachment_title": "some text",
            "attachment_description": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

chat.chat.AddInternalAttachment

Attach a internal file to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddInternalAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "chat.chat.AddInternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddInternalAttachments

Push information:

Pushing to: Chat users
With target: chat.chat.AddInternalAttachments
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • file_id_list - int list

Output:

  • success - bool
  • chat_id - int
  • messages - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.AddInternalAttachments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddMembers

Add members to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddMembers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • member_id_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • success - bool
  • chat_id - int
  • chat_users - LIST of ChatUser
  • chat_members - LIST of ChatMember

Example:

{
    "header": {
        "target": "chat.chat.AddMembers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.AddUsers

Add users to a chat

Push information:

Pushing to: Chat users
With target: chat.chat.AddUsers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • user_id_list - int list

Output:

  • success - bool
  • chat_id - int
  • added_user_id_list - LIST of int
  • chat_users - LIST of ChatUser

Example:

{
    "header": {
        "target": "chat.chat.AddUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.CanceledTyping

Send a notification that the user canceled typing

Push information:

Pushing to: Chat users
With target: chat.chat.CanceledTyping
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

  • user_id - int
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.CanceledTyping",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.ClearUnseen

Clear unseen count for chat

Push information:

Pushing to: Chat users
With target: chat.chat.ClearUnseen
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • delay_notifications - bool Optional: false

Output:

  • success - bool
  • chat_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "chat.chat.ClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "delay_notifications": true
        }
    }
}

chat.chat.Create

Create a group chat

Push information:

Pushing to: Self
With target: chat.chat.Create
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • users - int list Optional: []
  • user_groups - int list Optional: []
  • name - string Optional: ""
  • use_existing - bool Optional: true
  • force_creation - bool Optional: false

Output:

  • success - bool
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "users": [
                12345,
                12346
            ],
            "user_groups": [
                12345,
                12346
            ],
            "name": "some text",
            "use_existing": true,
            "force_creation": true
        }
    }
}

chat.chat.CreateChannel

Create channel chat

Push information:

Pushing to: Self
With target: chat.chat.CreateChannel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.CreateChannel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.DeleteMessage

Delete a message
Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: User list
With target: chat.chat.DeleteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int (parameter needs to be owned by api user)

Body Data:

  • message_index - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "chat.chat.DeleteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.Disable

Disable a chat for a user
Remove the chat from the recent chats

Push information:

Pushing to: Self
With target: chat.chat.Disable
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

  • success - bool
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.Disable",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.DownloadAttachment

Download a chat attachment

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_id - int
  • chat_id - int

Output:

  • md5 - string - can be null
  • date - string
  • name - string
  • size - int - can be null
  • file_path - string - can be missing
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "chat.chat.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.EditMessage

Edit a message

Push information:

Pushing to: Chat users
With target: chat.chat.EditMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int (parameter needs to be owned by api user)

Body Data:

  • message - string
  • message_index - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "chat.chat.EditMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "message_index": 12345
        }
    }
}

chat.chat.EditName

Edit a chat name

Push information:

Pushing to: Chat users
With target: chat.chat.EditName
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • name - string

Output:

  • success - bool
  • chat_id - int
  • name - string

Example:

{
    "header": {
        "target": "chat.chat.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

chat.chat.FavoriteMessage

Favorite a message

Push information:

Pushing to: Self
With target: chat.chat.FavoriteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int

Body Data:

  • message_index - int Optional: 0

Output:

  • success - bool
  • chat_id - int
  • message_index - int
  • message_id - int

Example:

{
    "header": {
        "target": "chat.chat.FavoriteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.GetAttachmentList

Get attachment list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

Example:

{
    "header": {
        "target": "chat.chat.GetAttachmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetChat

Get chat
with or without messages, default with

Push information:

Pushing to: Self
With target: chat.chat.GetChat
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • with_messages - bool Optional: true
  • limit - int Optional: 30

Output:

  • success - bool
  • chat_id - int
  • chat - ChatFull

Example:

{
    "header": {
        "target": "chat.chat.GetChat",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "with_messages": true,
            "limit": 12345
        }
    }
}

chat.chat.GetFavorites

Get favorite list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

Example:

{
    "header": {
        "target": "chat.chat.GetFavorites",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetLinks

Get shared links in a chat

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

Example:

{
    "header": {
        "target": "chat.chat.GetLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.GetList

Get chat list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • comment_count - bool Optional: false
  • offset - int Optional: 0
  • limit - int Optional: 1000

Output:

Example:

{
    "header": {
        "target": "chat.chat.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "comment_count": true,
            "offset": 12345,
            "limit": 12345
        }
    }
}

chat.chat.GetMessageBeforeAfter

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int

Body Data:

  • message_index - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "chat.chat.GetMessageBeforeAfter",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.LoadMessages

Get chat messages from offset of given message id, until limit

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int Optional: null

Body Data:

  • offset - int Optional: 0
  • limit - int Optional: 30

Output:

  • success - bool
  • chat_id - int
  • messages - LIST of ChatMessage

Example:

{
    "header": {
        "target": "chat.chat.LoadMessages",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "offset": 12345,
            "limit": 12345
        }
    }
}

chat.chat.PostMessage

Post message to chat

Push information:

Pushing to: Chat users
With target: chat.chat.PostMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • chat_id - int

Body Data:

  • message - string
  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

Example:

{
    "header": {
        "target": "chat.chat.PostMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "integration_attachment": "no example yet"
        }
    }
}

chat.chat.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • attachment_id - int Optional: null
  • chat_id - int

Body Data:

  • preview_type - string Optional: "default"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • output_type - string
  • doc_type - string
  • doc_id - int

Example:

{
    "header": {
        "target": "chat.chat.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

chat.chat.RemoveMembers

Remove members from a chat

Push information:

Pushing to: User list
With target: chat.chat.RemoveMembers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • member_id_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • success - bool
  • chat_id - int
  • chat_users - LIST of ChatUser
  • chat_members - LIST of ChatMember

Example:

{
    "header": {
        "target": "chat.chat.RemoveMembers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.RemoveUsers

Remove users from a chat

Push information:

Pushing to: Chat users
With target: chat.chat.RemoveUsers
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • user_id_list - int list

Output:

  • success - bool
  • chat_id - int
  • removed_user_id_list - LIST of int
  • chat_users - LIST of ChatUser

Example:

{
    "header": {
        "target": "chat.chat.RemoveUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.Search

Search through chat messages

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • search - string

Output:

Example:

{
    "header": {
        "target": "chat.chat.Search",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "search": "some text"
        }
    }
}

chat.chat.SetMessageIntegrationAttachment

Set the integration attachment for a message

Push information:

Pushing to: Chat users
With target: chat.chat.SetMessageIntegrationAttachment
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • chat_id - int
  • message_id - int (parameter needs to be owned by api user)

Body Data:

  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

Example:

{
    "header": {
        "target": "chat.chat.SetMessageIntegrationAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet"
        }
    }
}

chat.chat.SetSilent

Set silent for chat

Push information:

Pushing to: Self
With target: chat.chat.SetSilent
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • silent - bool
  • silent_until - datetime Optional: null

Output:

  • success - bool
  • chat_id - int
  • user_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "chat.chat.SetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

chat.chat.StartedTyping

Send a notification that the user is typing

Push information:

Pushing to: Chat users
With target: chat.chat.StartedTyping
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Output:

  • user_id - int
  • chat_id - int

Example:

{
    "header": {
        "target": "chat.chat.StartedTyping",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

chat.chat.UnfavoriteMessage

Unfavorite a message

Push information:

Pushing to: Self
With target: chat.chat.UnfavoriteMessage
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int
  • message_id - int

Body Data:

  • message_index - int Optional: 0

Output:

  • success - bool
  • chat_id - int
  • message_index - int
  • message_id - int

Example:

{
    "header": {
        "target": "chat.chat.UnfavoriteMessage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "message_index": 12345
        }
    }
}

chat.chat.UpdateGroupChatProfilePicture

Push information:

Pushing to: Chat users
With target: chat.chat.UpdateGroupChatProfilePicture
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • chat_id - int

Body Data:

  • name - string Optional: ""
  • size - int Optional: 0

Output:

  • success - bool
  • chat_id - int
  • custom_image_id - int

Example:

{
    "header": {
        "target": "chat.chat.UpdateGroupChatProfilePicture",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

chat.message.AddMessageReaction

Add a reaction for a message

Push information:

Pushing to: Chat users
With target: chat.message.AddMessageReaction
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • chat_id - int
  • message_id - int

Body Data:

  • reaction - Emoji

Output:

  • success - bool
  • chat_id - int
  • message_id - int
  • user_id - int
  • reaction - string

Example:

{
    "header": {
        "target": "chat.message.AddMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

chat.message.DeleteMessageReaction

Delete a reaction for a message

Push information:

Pushing to: Chat users
With target: chat.message.DeleteMessageReaction
Stream value: Pushing on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • chat_id - int
  • message_id - int

Body Data:

  • reaction - Emoji

Output:

  • success - bool
  • chat_id - int
  • message_id - int
  • user_id - int
  • reaction - string

Example:

{
    "header": {
        "target": "chat.message.DeleteMessageReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "message_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "copyright"
        }
    }
}

comment.comment.GetCommentsForItem

Get a specific user commented item

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • item_id - int
  • item_type_id - int

Output:

Example:

{
    "header": {
        "target": "comment.comment.GetCommentsForItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "item_id": 12345,
            "item_type_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

comment.comment.GetUserCommentedItems

Get user commented items

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "comment.comment.GetUserCommentedItems",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.air.CreatePersistentRoom

create a persistent room

Push information:

Pushing to: Unkown push action
With target: communication.air.CreatePersistentRoom
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • image - PersistentRoomImage
  • scope - int Optional: 1

Output:

Example:

{
    "header": {
        "target": "communication.air.CreatePersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "image": 12345,
            "scope": 12345
        }
    }
}

communication.air.GetPersistentRoom

Get persistent airtime room

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • room_id - PersistentRoom

Output:

Example:

{
    "header": {
        "target": "communication.air.GetPersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "room_id": 12345
        }
    }
}

communication.air.ScheduleCall

Schedule an AirTime call
Sends an invitation email to all participants

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_project_id - int Optional: null
  • user_id_list - int list

Body Data:

  • title - string
  • description - string
  • date - datetime
  • duration - int
  • room - string
  • reminders - list Optional: []
  • external_participants - list Optional: []
  • should_notify - bool Optional: true

Output:

  • success - bool
  • ics - string

Example:

{
    "header": {
        "target": "communication.air.ScheduleCall",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "title": "some text",
            "description": "some text",
            "date": "2016-11-27 17:10:05",
            "duration": 12345,
            "room": "some text",
            "reminders": "no example yet",
            "external_participants": [
                {
                    "email": "external_user1@domain.com",
                    "first_name": "first_name1",
                    "last_name": "last_name1"
                },
                {
                    "email": "external_user2@domain.com",
                    "first_name": "first_name2",
                    "last_name": "last_name2"
                }
            ],
            "should_notify": true
        }
    }
}

communication.chat.ConversationArchive

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int

Example:

{
    "header": {
        "target": "communication.chat.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationArchiveList

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationArchiveList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id_list - LIST of int
  • item_type_id - int

Example:

{
    "header": {
        "target": "communication.chat.ConversationArchiveList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationClearUnseen

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "communication.chat.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationCommentAdded

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationCommentAdded
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "communication.chat.ConversationCommentAdded",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationCommentEdited

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationCommentEdited
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "communication.chat.ConversationCommentEdited",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationCommentReactionToggled

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationCommentReactionToggled
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • comment_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "communication.chat.ConversationCommentReactionToggled",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationCommentRemoved

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationCommentRemoved
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "communication.chat.ConversationCommentRemoved",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

communication.chat.ConversationSetSilent

Push information:

Pushing to: Whole account
With target: communication.chat.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • item_id - int
  • item_type_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "communication.chat.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.AddComment

Add comment to a directory

Push information:

Pushing to: Project users
With target: document.directory.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "document.directory.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.directory.AddLink

Add link to directory

Push information:

Pushing to: Project users
With target: document.directory.AddLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • url - string
  • title - string

Output:

  • success - bool
  • link - Link

Example:

{
    "header": {
        "target": "document.directory.AddLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "url": "mylabel1",
            "title": "mylabel1"
        }
    }
}

document.directory.AddMembersToDir

Add members to dir
Return all users having access to dir

Push information:

Pushing to: Project users
With target: document.directory.AddMembersToDir
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • group_member_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • member_access_list - LIST of MemberAccess
  • dir_id - int
  • dir_auth - int

Example:

{
    "header": {
        "target": "document.directory.AddMembersToDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationArchive

Archive a conversation

Push information:

Pushing to: Self
With target: document.directory.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • success - bool
  • dir_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "document.directory.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: document.directory.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • success - bool
  • dir_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "document.directory.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: document.directory.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Body Data:

  • silent - bool
  • silent_until - datetime Optional: null

Output:

  • success - bool
  • dir_id - int
  • user_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "document.directory.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

document.directory.Copy

Copy a directory elsewhere

Push information:

Pushing to: Project users
With target: document.directory.Copy
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • dest_dir_id - int Optional: null
  • target_project_id - int Optional: null

Body Data:

  • name - string

Output:

  • dir_id - int

Example:

{
    "header": {
        "target": "document.directory.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.directory.CopyList

Copy a list of directory elsewhere

Push information:

Pushing to: Project users
With target: document.directory.CopyList
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list
  • dest_dir_id - int Optional: null
  • target_project_id - int Optional: null

Body Data:

  • copy_meta - bool Optional: false

Output:

  • success - bool
  • dir_id - int
  • target_project_id - int
  • dirs - LIST of struct - can be missing
    • success - bool
    • dir - Directory - can be missing
    • error - Error - can be missing

Example:

{
    "header": {
        "target": "document.directory.CopyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "copy_meta": true
        }
    }
}

document.directory.Create

Creates a directory

Push information:

Pushing to: Project users
With target: document.directory.Create
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • name - string
  • conflict_rename - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "document.directory.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "conflict_rename": true
        }
    }
}

document.directory.CreateDirectoryTree

Creates a directory tree when uploading a folder

Push information:

Pushing to: Project users
With target: document.directory.CreateDirectoryTree
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • relative_path_list - string list

Output:

Example:

{
    "header": {
        "target": "document.directory.CreateDirectoryTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "relative_path_list": [
                "string1",
                "string2",
                "string3"
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.DeleteComment

Delete a directory comment
Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Project users
With target: document.directory.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • comment_id - int (parameter needs to be owned by api user)

Output:

  • success - bool
  • dir_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "document.directory.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.DeniedList

Get the list of denied directories for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • group_member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • dir_id_list - LIST of int

Example:

{
    "header": {
        "target": "document.directory.DeniedList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.EditComment

Edit a comment of a directory

Push information:

Pushing to: Project users
With target: document.directory.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "document.directory.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.directory.EditMembersAccessToDirectories

Edits members access on one or several directories

Push information:

Pushing to: Project users
With target: document.directory.EditMembersAccessToDirectories
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • member_id_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Body Data:

  • dir_access_array - assoc array int to in

Output:

  • success - bool
  • dirs - LIST of struct
    • success - bool
    • dir_id - int
    • dir_auth - int
    • member_access_list - LIST of MemberAccess
    • directory - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.EditMembersAccessToDirectories",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "member_id_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {
            "dir_access_array": {
                "1": 0,
                "2": 1,
                "5": 2
            }
        }
    }
}

document.directory.EditName

Edits the name of a directory

Push information:

Pushing to: Project users
With target: document.directory.EditName
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Body Data:

  • name - string
  • conflict_rename - bool Optional: false

Output:

  • name - string
  • dir_id - int

Example:

{
    "header": {
        "target": "document.directory.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "conflict_rename": true
        }
    }
}

document.directory.Get

Get a directory only given its id

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • dir_id - int

Output:

Example:

{
    "header": {
        "target": "document.directory.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetComments

Get comments of a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

Example:

{
    "header": {
        "target": "document.directory.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetDirectoryUsers

Get list of all users having access to given directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • users - LIST of User

Example:

{
    "header": {
        "target": "document.directory.GetDirectoryUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetMembersAccess

Get users access of a dir

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • dir_id - int
  • dir_auth - int
  • member_access_list - LIST of MemberAccess

Example:

{
    "header": {
        "target": "document.directory.GetMembersAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.GetReadOnlyStateForUser

Get the read only state of the directory for the current user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • success - bool
  • is_read_only - bool

Example:

{
    "header": {
        "target": "document.directory.GetReadOnlyStateForUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.LinkPathInfo

Get file path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • link_id - Link

Output:

  • path_ids - LIST of int
  • link_id - int

Example:

{
    "header": {
        "target": "document.directory.LinkPathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.Move

Move directories to a folder

Push information:

Pushing to: Project users
With target: document.directory.Move
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • dir_id_list - int list
  • target_project_id - int Optional: null

Body Data:

  • conflict_rename - bool Optional: false

Output:

  • success - bool
  • conflicts_count - int
  • conflicts - LIST of struct - can be missing
    • dir_id - int
    • dir_name - string
    • alt_name - string
  • nb_dirs - int - can be missing
  • dir_id - int - can be missing
  • dirs - LIST of struct - can be missing
    • error - Error - can be missing
    • success - bool - can be missing
    • dir - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "conflict_rename": true
        }
    }
}

document.directory.MoveLink

Move links from one directory to another

Push information:

Pushing to: Project users
With target: document.directory.MoveLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • link_id_list - int list
  • target_project_id - int Optional: null

Output:

  • links - LIST of Link
  • dir_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.directory.MoveLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.MoveToGarbageCollector

Permanently delete one or more directories

Push information:

Pushing to: Project users
With target: document.directory.MoveToGarbageCollector
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list

Output:

  • success - bool
  • dirs - LIST of struct
    • error - Error - can be missing
    • success - bool - can be missing
    • dir_id - int - can be missing

Example:

{
    "header": {
        "target": "document.directory.MoveToGarbageCollector",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.MoveToTrash

Delete one or more directories

Push information:

Pushing to: Project users
With target: document.directory.MoveToTrash
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list

Output:

  • success - bool
  • dirs - LIST of struct
    • error - Error - can be missing
    • success - bool - can be missing
    • dir_id - int - can be missing

Example:

{
    "header": {
        "target": "document.directory.MoveToTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.PathInfo

Get directory path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • path_ids - LIST of int
  • path_names - LIST of string

Example:

{
    "header": {
        "target": "document.directory.PathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.PromoteToProject

Creates a project from a directory

Push information:

Pushing to: User list
With target: document.directory.PromoteToProject
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • category_id - int
  • new_category_name - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "document.directory.PromoteToProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "category_id": 12345,
            "new_category_name": "some text"
        }
    }
}

document.directory.RemoveMembersFromDir

Remove members from dir
Return all users having access to dir

Push information:

Pushing to: Project users
With target: document.directory.RemoveMembersFromDir
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • group_member_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • member_access_list - LIST of MemberAccess
  • dir_id - int
  • dir_auth - int

Example:

{
    "header": {
        "target": "document.directory.RemoveMembersFromDir",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.directory.RemoveProperty

Remove a property from a directory

Push information:

Pushing to: Project users
With target: document.directory.RemoveProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • property_label - string

Body Data:

  • subdirs - bool Optional: false

Output:

  • success - bool
  • dir_id_list - LIST of int
  • property - Property

Example:

{
    "header": {
        "target": "document.directory.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "subdirs": true
        }
    }
}

document.directory.Restore

Restore one or more directories from trash

Push information:

Pushing to: Project users
With target: document.directory.Restore
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list

Body Data:

  • dir_id - int Optional: null

Output:

  • success - bool
  • dirs - LIST of struct
    • error - int - can be missing
    • error_str - string - can be missing
    • success - bool - can be missing
    • dir_id - int - can be missing
    • parent_id - int - can be missing
    • dir - Directory - can be missing

Example:

{
    "header": {
        "target": "document.directory.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {
            "dir_id": 12345
        }
    }
}

document.directory.SetDirectoryDefault

Set default access on a directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Body Data:

  • access - int Optional: 0

Output:

  • success - bool
  • dir_id - int
  • access - int

Example:

{
    "header": {
        "target": "document.directory.SetDirectoryDefault",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {
            "access": 12345
        }
    }
}

document.directory.SetPropertyValue

Push information:

Pushing to: Project users
With target: document.directory.SetPropertyValue
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • property_label - string

Body Data:

  • value - string
  • subdirs - bool Optional: false

Output:

  • success - bool
  • dir_id_list - LIST of int
  • property - Property

Example:

{
    "header": {
        "target": "document.directory.SetPropertyValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1",
            "subdirs": true
        }
    }
}

document.directory.ToggleCommentReaction

Toggle a reaction to a comment

Push information:

Pushing to: Project users
With target: document.directory.ToggleCommentReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • dir_id - int
  • comment_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "document.directory.ToggleCommentReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

document.entry.DirList

List folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "document.entry.DirList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.entry.GetProjectTree

Get flat tree for project
Get a flat tree, ordered by path

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "document.entry.GetProjectTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.entry.GetSharingZipperFileList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list Optional: []
  • file_id_list - int list Optional: []
  • sharing_code - string

Body Data:

  • recursive - bool Optional: false
  • sharing_pwd - string Optional: ""

Output:

  • entries - LIST of struct
    • zip_name - string
    • name - string
    • path - string
    • fs_name - string
    • file_id - int
  • storage_id - int

Example:

{
    "header": {
        "target": "document.entry.GetSharingZipperFileList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "recursive": true,
            "sharing_pwd": "some text"
        }
    }
}

document.entry.GetZipperFileList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list Optional: []
  • file_id_list - int list Optional: []

Body Data:

  • recursive - bool Optional: false

Output:

  • entries - LIST of struct
    • zip_name - string
    • name - string
    • file_id - int
    • account_id - int
    • project_id - int
    • type - string
    • output_type - string
  • storage_id - int

Example:

{
    "header": {
        "target": "document.entry.GetZipperFileList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "recursive": true
        }
    }
}

document.entry.List

List the files and folders found in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • no_comment_count - bool Optional: false
  • process_thumbnail - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "document.entry.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "no_comment_count": true,
            "process_thumbnail": true
        }
    }
}

document.entry.ListServiceEntries

List the service entries of a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • cloud_reference - string Optional: null

Output:

  • success - bool
  • entries - object - can be missing
  • url - string - can be missing

Example:

{
    "header": {
        "target": "document.entry.ListServiceEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "cloud_reference": "some text"
        }
    }
}

document.entry.TrashList

List the files, the link and folders found in the trash

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "document.entry.TrashList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.ActivateSharing

Activate sharing on one file

Push information:

Pushing to: Project users
With target: document.file.ActivateSharing
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

  • file_id - int
  • file_master_id - int
  • code - string
  • file - File
  • url - string

Example:

{
    "header": {
        "target": "document.file.ActivateSharing",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.AddComment

Add a file comment

Push information:

Pushing to: Project users
With target: document.file.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Body Data:

  • comment - string

Output:

  • file_id - int
  • file_master_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "document.file.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.file.AddTag

Add a tag on a file

Push information:

Pushing to: Project users
With target: document.file.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • label - string

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "document.file.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

document.file.AttachmentIntoDoc

Take an attachment from chat or task and add it to the document module
Take an attachment from chat or task and add it to the document module

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • attachment_id - int
  • dir_id - int Optional: null

Output:

  • success - bool
  • file - File

Example:

{
    "header": {
        "target": "document.file.AttachmentIntoDoc",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.CheckConflict

check a file name conflict

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • name - string

Output:

  • conflict - bool
  • alt_name - string - can be missing

Example:

{
    "header": {
        "target": "document.file.CheckConflict",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.file.CheckConflicts

Check conflicts of a specific name in a folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • file_name - string

Output:

  • success - bool
  • conflict - bool
  • conflict_file_id - int - can be missing
  • alt_name - string - can be missing

Example:

{
    "header": {
        "target": "document.file.CheckConflicts",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "file_name": "some text"
        }
    }
}

document.file.ConversationArchive

Archive a conversation

Push information:

Pushing to: Self
With target: document.file.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int

Output:

  • success - bool
  • file_master_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "document.file.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: document.file.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int

Output:

  • success - bool
  • file_master_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "document.file.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: document.file.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int

Body Data:

  • silent - bool
  • silent_until - datetime Optional: null

Output:

  • success - bool
  • file_master_id - int
  • user_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "document.file.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

document.file.Copy

Copy a file elsewhere

Push information:

Pushing to: Project users
With target: document.file.Copy
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int
  • target_project_id - int Optional: null
  • dest_dir_id - int Optional: null

Body Data:

  • name - string

Output:

Example:

{
    "header": {
        "target": "document.file.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

document.file.CopyList

Copy a list of file elsewhere

Push information:

Pushing to: Project users
With target: document.file.CopyList
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id_list - int list Optional: []
  • target_project_id - int Optional: null
  • dest_dir_id - int Optional: null

Body Data:

  • copy_meta - bool Optional: false

Output:

  • success - bool
  • dir_id - int
  • target_project_id - int
  • files - LIST of struct - can be missing
    • success - bool
    • file - File - can be missing
    • error - Error - can be missing

Example:

{
    "header": {
        "target": "document.file.CopyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "copy_meta": true
        }
    }
}

document.file.CreateFromTemplate

Create a file from a given template

Push information:

Pushing to: Project users
With target: document.file.CreateFromTemplate
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • file_template_id - int

Body Data:

  • name - string Optional: ""
  • process_thumbnail - bool Optional: false

Output:

  • file - File
  • id_version_of - int

Example:

{
    "header": {
        "target": "document.file.CreateFromTemplate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "process_thumbnail": true
        }
    }
}

document.file.DeactivateSharing

Deactivate sharing on one file

Push information:

Pushing to: Project users
With target: document.file.DeactivateSharing
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

  • file_id - int
  • file_master_id - int

Example:

{
    "header": {
        "target": "document.file.DeactivateSharing",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.DeleteComment

Delete a file comment
Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Project users
With target: document.file.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null
  • comment_id - int (parameter needs to be owned by api user)

Output:

  • success - bool
  • file_id - int
  • file_master_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "document.file.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Download

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "document.file.Download",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.DownloadForPreviewInternal

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • file - File
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string

Example:

{
    "header": {
        "target": "document.file.DownloadForPreviewInternal",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.EditComment

Edit a file comment

Push information:

Pushing to: Project users
With target: document.file.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • comment - string

Output:

  • file_id - int
  • file_master_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "document.file.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "some text"
        }
    }
}

document.file.EditDescription

Edit a file description

Push information:

Pushing to: Project users
With target: document.file.EditDescription
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • description - string

Output:

  • file_id - int
  • file_master_id - int
  • info - string
  • enhanced_info - string
  • file - File

Example:

{
    "header": {
        "target": "document.file.EditDescription",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "description": "some text"
        }
    }
}

document.file.EditName

Edits the name of a file

Push information:

Pushing to: Project users
With target: document.file.EditName
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • name - string
  • conflict_rename - bool Optional: false

Output:

  • name - string
  • file_id - int
  • file_master_id - int
  • file - File

Example:

{
    "header": {
        "target": "document.file.EditName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "conflict_rename": true
        }
    }
}

document.file.GetComments

Get the comments of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "document.file.GetComments",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetDownloadToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Output:

  • token - string

Example:

{
    "header": {
        "target": "document.file.GetDownloadToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetEvents

Get the historical events of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "document.file.GetEvents",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetIPTCMetadata

Get IPTC data for a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "document.file.GetIPTCMetadata",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetMetaDataFields

Get all metadata fields for account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • fields - LIST of string

Example:

{
    "header": {
        "target": "document.file.GetMetaDataFields",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetOnlineEditionFileToken

Get file token for editing file online using only office
Use the same token with other users to co edit the same file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int

Output:

  • office_file_token - string

Example:

{
    "header": {
        "target": "document.file.GetOnlineEditionFileToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetProperties

get the properties of a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_id_list - int list Optional: []

Output:

  • file_list - LIST of File

Example:

{
    "header": {
        "target": "document.file.GetProperties",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GetVersions

Get a file's versions list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

  • versions - LIST of File

Example:

{
    "header": {
        "target": "document.file.GetVersions",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.GuestLink

Get guest link of a file - DEPRECATED - use ActivateSharing

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

  • url - string
  • file - File

Example:

{
    "header": {
        "target": "document.file.GuestLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.IsVersionOf

Checks if a version of a file is on the server (by md5)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_id - int

Body Data:

  • file_md5 - string

Output:

  • found - bool

Example:

{
    "header": {
        "target": "document.file.IsVersionOf",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "file_md5": "some text"
        }
    }
}

document.file.LinkTag

Link a tag to a file

Push information:

Pushing to: Project users
With target: document.file.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • tag_id - int

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "document.file.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Lock

Used to lock a file.
By default, you cannot lock a file if is it already locked by a different user. Use the  force parameter to perform the action regardless of that constraint.

Push information:

Pushing to: Project users
With target: document.file.Lock
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • force - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "document.file.Lock",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

document.file.Move

Move files to a folder

Push information:

Pushing to: Project users
With target: document.file.Move
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • file_id_list - int list
  • target_project_id - int Optional: null

Body Data:

  • operation - string Optional: ""

Output:

  • success - bool
  • conflicts_count - int
  • conflicts - LIST of struct - can be missing
    • file_id - int
    • file_name - string
    • alt_name - string
  • nb_files - int - can be missing
  • dir_id - int - can be missing
  • files - LIST of struct - can be missing
    • error - Error - can be missing
    • success - bool - can be missing
    • file - File - can be missing

Example:

{
    "header": {
        "target": "document.file.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "operation": "some text"
        }
    }
}

document.file.MoveToGarbageCollector

Permanently delete one or more files

Push information:

Pushing to: Project users
With target: document.file.MoveToGarbageCollector
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id_list - int list

Body Data:

  • force - bool Optional: false

Output:

  • success - bool
  • files - LIST of struct
    • error - Error - can be missing
    • success - bool - can be missing
    • file_id - int - can be missing
    • file_master_id - int - can be missing

Example:

{
    "header": {
        "target": "document.file.MoveToGarbageCollector",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

document.file.MoveToTrash

Delete one or more files

Push information:

Pushing to: Project users
With target: document.file.MoveToTrash
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id_list - int list

Output:

  • success - bool
  • files - LIST of struct
    • error - Error - can be missing
    • success - bool - can be missing
    • file_id - int - can be missing
    • id_version_of - int - can be missing
    • file_master_id - int - can be missing

Example:

{
    "header": {
        "target": "document.file.MoveToTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.file.NotifyOpen

Warn users that a specific file is being opened

Push information:

Pushing to: User list
With target: document.file.NotifyOpen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "document.file.NotifyOpen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.PathInfo

Get file path info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null

Output:

  • path_ids - LIST of int
  • path_names - LIST of string
  • file_id - int

Example:

{
    "header": {
        "target": "document.file.PathInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.RemoveProperty

Remove a property from a file

Push information:

Pushing to: Project users
With target: document.file.RemoveProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • property_label - string

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • property - Property

Example:

{
    "header": {
        "target": "document.file.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

document.file.RemoveTag

Remove a tag in a file

Push information:

Pushing to: Project users
With target: document.file.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • tag_id - int

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "document.file.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.RemoveTagByLabel

Remove a tag in a file using the label

Push information:

Pushing to: Project users
With target: document.file.RemoveTagByLabel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • label - string

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "document.file.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Restore

Restore one or more files

Push information:

Pushing to: Project users
With target: document.file.Restore
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id_list - int list

Body Data:

  • dir_id - int Optional: null

Output:

  • success - bool
  • files - LIST of struct
    • success - bool
    • file_id - int
    • parent_id - int
    • file - File - can be missing
    • error - int - can be missing
    • error_str - string - can be missing

Example:

{
    "header": {
        "target": "document.file.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "dir_id": 12345
        }
    }
}

document.file.SetPropertyValue

Set a property to a file
Add the property + value if the property does not exist on this file yet

Push information:

Pushing to: Project users
With target: document.file.SetPropertyValue
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • property_label - string

Body Data:

  • value - string

Output:

  • success - bool
  • file_master_id - int
  • file_id - int
  • property - Property

Example:

{
    "header": {
        "target": "document.file.SetPropertyValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "property_label": "mylabel1"
        }
    },
    "body": {
        "data": {
            "value": "mylabel1"
        }
    }
}

document.file.ToggleCommentReaction

Toggle a reaction to a comment

Push information:

Pushing to: Project users
With target: document.file.ToggleCommentReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int Optional: null
  • file_master_id - int Optional: null
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • file_id - int
  • file_master_id - int
  • comment_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "document.file.ToggleCommentReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

document.file.Unlock

Used to unlock a file.
By default, you cannot unlock a file if is it already locked by a different user. Use the  force parameter to perform the action regardless of that constraint.

Push information:

Pushing to: Project users
With target: document.file.Unlock
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • force - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "document.file.Unlock",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "force": true
        }
    }
}

document.file.Unversion

Unversion one file

Push information:

Pushing to: Project users
With target: document.file.Unversion
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "document.file.Unversion",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.file.Upload

Push information:

Pushing to: Project users
With target: document.file.Upload
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • file_id - int Optional: null

Body Data:

  • notify - bool Optional: false
  • timestamp - string Optional: ""
  • replace_master - bool Optional: false
  • conflict_rename - bool Optional: false
  • md5 - string Optional: ""
  • name - string
  • info - string Optional: ""
  • size - int
  • process_thumbnail - bool Optional: false

Output:

  • file - File
  • id_version_of - int

Example:

{
    "header": {
        "target": "document.file.Upload",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "notify": true,
            "timestamp": "some text",
            "replace_master": true,
            "conflict_rename": true,
            "md5": "some text",
            "name": "some text",
            "info": "some text",
            "size": 12345,
            "process_thumbnail": true
        }
    }
}

document.general_file.GetDownloadToken

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • attachment_id - int

Output:

  • token - string

Example:

{
    "header": {
        "target": "document.general_file.GetDownloadToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.general_file.GetOnlineEditionGeneralFileToken

Get file token for editing external file online using only office
Use the same token with other users to co edit the same file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • general_file_id - int

Output:

  • office_general_file_token - string

Example:

{
    "header": {
        "target": "document.general_file.GetOnlineEditionGeneralFileToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "general_file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.service.BringBack

Bring backs a service file back to the wimi (and removes the .html in wimi if it succeeds). Only works with google ATM.

Push information:

Pushing to: Project users
With target: document.service.BringBack
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int
  • dir_id - int Optional: null

Body Data:

  • service - string
  • format - string Optional: ""

Output:

  • success - bool
  • file - File - can be missing
  • dir_id - int - can be missing - can be null
  • old_file_id - int - can be missing - can be null
  • url - string - can be missing
  • msg - string - can be missing
  • formats - LIST of string - can be missing

Example:

{
    "header": {
        "target": "document.service.BringBack",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "format": "some text"
        }
    }
}

document.service.CheckToken

Check service token

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • service - string

Output:

  • success - bool
  • url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.CheckToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text"
        }
    }
}

document.service.Download

Directly download the document from the service. Only google is supported right now.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • service - string
  • format - string Optional: ""

Output:

  • success - bool
  • formats - LIST of string - can be missing
  • download_url - string - can be missing
  • url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.Download",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "format": "some text"
        }
    }
}

document.service.Edit

Edit (and upload) a file to service. Only google is supported right now.

Push information:

Pushing to: Project users
With target: document.service.Edit
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • service - string

Output:

  • success - bool
  • file - File - can be missing
  • id_version_of - int - can be missing - can be null
  • url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.Edit",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text"
        }
    }
}

document.service.GetEntries

Get service entries

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • service - string
  • folder_ref - string Optional: ""

Output:

  • success - bool
  • entries - object - can be missing
  • url - string - can be missing

Example:

{
    "header": {
        "target": "document.service.GetEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "folder_ref": "some text"
        }
    }
}

document.service.ImportEntries

Import service entries

Push information:

Pushing to: Project users
With target: document.service.ImportEntries
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • service - string
  • files - Array
  • dir_id - int Optional: null

Output:

  • files - LIST of File

Example:

{
    "header": {
        "target": "document.service.ImportEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "files": [
                1,
                2,
                3,
                4
            ],
            "dir_id": 12345
        }
    }
}

document.service.LinkDirs

Link directories from service entries

Push information:

Pushing to: Project users
With target: document.service.LinkDirs
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null

Body Data:

  • service - string
  • dirs - Array

Output:

Example:

{
    "header": {
        "target": "document.service.LinkDirs",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "dirs": [
                1,
                2,
                3,
                4
            ]
        }
    }
}

document.sharing.Activate

Activate sharing on one directory

Push information:

Pushing to: Project users
With target: document.sharing.Activate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • dir_id - int
  • code - string
  • password - string - can be null

Example:

{
    "header": {
        "target": "document.sharing.Activate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.AllowInvisibleSub

Allow invisible subdirectories on a shared folder

Push information:

Pushing to: Project users
With target: document.sharing.AllowInvisibleSub
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Output:

  • dir_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.AllowInvisibleSub",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.AllowUpload

Allow upload on a given shared folder

Push information:

Pushing to: Project users
With target: document.sharing.AllowUpload
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Output:

  • dir_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.AllowUpload",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.Deactivate

Deactivate sharing on one directory

Push information:

Pushing to: Project users
With target: document.sharing.Deactivate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int

Output:

  • dir_id - int

Example:

{
    "header": {
        "target": "document.sharing.Deactivate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.DisallowInvisibleSub

Disallow invisible subs on a shared folder

Push information:

Pushing to: Project users
With target: document.sharing.DisallowInvisibleSub
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Output:

  • dir_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.DisallowInvisibleSub",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.DisallowUpload

Disallow upload on a given shared folder

Push information:

Pushing to: Project users
With target: document.sharing.DisallowUpload
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Output:

  • dir_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.DisallowUpload",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.ExportAsCsv

Activate sharing on one directory

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • file_name - string Optional: "shared_links"
  • delimiter - string Optional: ";"
  • enclosure - string Optional: """

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.ExportAsCsv",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "file_name": "some text",
            "delimiter": "some text",
            "enclosure": "some text"
        }
    }
}

document.sharing.RemovePassword

Remove a password of a shared folder

Push information:

Pushing to: Project users
With target: document.sharing.RemovePassword
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Output:

  • item_id - int
  • item_type_id - int
  • success - bool

Example:

{
    "header": {
        "target": "document.sharing.RemovePassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {}
    }
}

document.sharing.SetExpirationDate

Set an expiration date for an item

Push information:

Pushing to: Project users
With target: document.sharing.SetExpirationDate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Body Data:

  • sharing_expiration_date - datetime

Output:

  • item_id - int
  • item_type_id - int
  • success - bool
  • sharing_expiration_date - datetime - can be null

Example:

{
    "header": {
        "target": "document.sharing.SetExpirationDate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_expiration_date": "2016-11-27 17:10:05"
        }
    }
}

document.sharing.SetPassword

Set a password for an item

Push information:

Pushing to: Project users
With target: document.sharing.SetPassword
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • item_id - int
  • item_type_id - int
  • success - bool
  • password - string

Example:

{
    "header": {
        "target": "document.sharing.SetPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

document.signature.DownloadAttachment

Download a chat attachment

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • attachment_id - int
  • signature_id - int

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string
  • attachment - ExternalAttachment
  • item_type_id - int

Example:

{
    "header": {
        "target": "document.signature.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "attachment_id": 12345,
            "signature_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.signature.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • attachment_id - int
  • signature_id - int

Body Data:

  • preview_type - string Optional: "default"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • doc_type - string
  • doc_id - int
  • output_type - string

Example:

{
    "header": {
        "target": "document.signature.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "attachment_id": 12345,
            "signature_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

document.signature.SignatureFromExternalFile

Create a file signature from an external file

Push information:

Pushing to: Whole account
With target: document.signature.SignatureFromExternalFile
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_name - string Optional: ""

Body Data:

  • name - string
  • size - int

Output:

  • general_file_id - int

Example:

{
    "header": {
        "target": "document.signature.SignatureFromExternalFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

document.signature.SignatureFromInternalFile

Create a Signature from an internal (already existent in account) file

Push information:

Pushing to: Whole account
With target: document.signature.SignatureFromInternalFile
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Output:

  • general_file_id - int
  • file_size - int
  • file_name - string

Example:

{
    "header": {
        "target": "document.signature.SignatureFromInternalFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.AddTag

Add a tag on a general file template

Push information:

Pushing to: Whole account
With target: document.template.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int
  • label - string
  • color - int Optional: 3

Output:

Example:

{
    "header": {
        "target": "document.template.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

document.template.CreateFromExternalFile

Create a file template from an external file

Push information:

Pushing to: Whole account
With target: document.template.CreateFromExternalFile
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • template_name - string
  • description - string Optional: ""
  • name - string
  • size - int

Output:

Example:

{
    "header": {
        "target": "document.template.CreateFromExternalFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "template_name": "mylabel1",
            "description": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

document.template.CreateFromInternalFile

Push information:

Pushing to: Whole account
With target: document.template.CreateFromInternalFile
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int

Body Data:

  • template_name - string
  • description - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "document.template.CreateFromInternalFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {
            "template_name": "mylabel1",
            "description": "some text"
        }
    }
}

document.template.LinkTag

Link tag to template

Push information:

Pushing to: Whole account
With target: document.template.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int
  • tag_id - int

Output:

Example:

{
    "header": {
        "target": "document.template.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.ListForAccount

List file templates of account

Push information:

Pushing to: Whole account
With target: document.template.ListForAccount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "document.template.ListForAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.PreviewTemplate

Request template preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int

Body Data:

  • preview_type - string Optional: "thumbnail_large"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • preview_type - string - can be missing
  • doc_type - string
  • doc_id - int
  • output_type - string

Example:

{
    "header": {
        "target": "document.template.PreviewTemplate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

document.template.RemoveTag

Remove tag from template

Push information:

Pushing to: Whole account
With target: document.template.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int
  • tag_id - int

Output:

Example:

{
    "header": {
        "target": "document.template.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.Restore

Restore trashed file template

Push information:

Pushing to: Whole account
With target: document.template.Restore
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int

Output:

Example:

{
    "header": {
        "target": "document.template.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.Trash

Put file template to trash
Still recoverable

Push information:

Pushing to: Whole account
With target: document.template.Trash
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int

Output:

Example:

{
    "header": {
        "target": "document.template.Trash",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.template.UpdateDescription

Update file template description

Push information:

Pushing to: Whole account
With target: document.template.UpdateDescription
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int

Body Data:

  • description - string

Output:

Example:

{
    "header": {
        "target": "document.template.UpdateDescription",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "description": "some text"
        }
    }
}

document.template.UpdateName

Update file template name

Push information:

Pushing to: Whole account
With target: document.template.UpdateName
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • file_template_id - int

Body Data:

  • name - string

Output:

Example:

{
    "header": {
        "target": "document.template.UpdateName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1"
        }
    }
}

document.trash.EmptyTrash

Empty the trash

Push information:

Pushing to: Project users
With target: document.trash.EmptyTrash
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.trash.EmptyTrash",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.trash.List

List the files found in the trash given a set of filters
Will return full stringified path as additional argument for display purposes

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • query - string Optional: ""
  • before_date - datetime Optional: null
  • after_date - datetime Optional: null
  • deleted_by - int Optional: 0
  • order_by - string Optional: ""
  • order_by_type - string Optional: ""
  • folder_name - string Optional: ""

Output:

  • files - LIST of File
  • count - int

Example:

{
    "header": {
        "target": "document.trash.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "query": "some text",
            "before_date": "2016-11-27 17:10:05",
            "after_date": "2016-11-27 17:10:05",
            "deleted_by": 12345,
            "order_by": "some text",
            "order_by_type": "some text",
            "folder_name": "some text"
        }
    }
}

document.trash.ListDirectories

List the folders found in the trash given a set of filters
Will return full stringified path as additional argument for display purposes

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • query - string Optional: ""
  • before_date - datetime Optional: null
  • after_date - datetime Optional: null
  • deleted_by - int Optional: 0
  • order_by - string Optional: ""
  • order_by_type - string Optional: ""
  • folder_name - string Optional: ""

Output:

  • directories - LIST of Directory
  • count - int

Example:

{
    "header": {
        "target": "document.trash.ListDirectories",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "query": "some text",
            "before_date": "2016-11-27 17:10:05",
            "after_date": "2016-11-27 17:10:05",
            "deleted_by": 12345,
            "order_by": "some text",
            "order_by_type": "some text",
            "folder_name": "some text"
        }
    }
}

document.trash.ListLinks

List the links found in the trash given a set of filters
Will return full stringified path as additional argument for display purposes

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • query - string Optional: ""
  • before_date - datetime Optional: null
  • after_date - datetime Optional: null
  • deleted_by - int Optional: 0
  • order_by - string Optional: ""
  • order_by_type - string Optional: ""
  • folder_name - string Optional: ""

Output:

  • links - LIST of Link
  • count - int

Example:

{
    "header": {
        "target": "document.trash.ListLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "query": "some text",
            "before_date": "2016-11-27 17:10:05",
            "after_date": "2016-11-27 17:10:05",
            "deleted_by": 12345,
            "order_by": "some text",
            "order_by_type": "some text",
            "folder_name": "some text"
        }
    }
}

document.trash.RestoreDirectories

Restore one or more directories

Push information:

Pushing to: Project users
With target: document.trash.RestoreDirectories
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id_list - int list

Output:

  • success - bool
  • directory_path_list - LIST of struct
    • success - bool
    • dir_id - int
    • path_ids - LIST of int - can be missing
    • error - int - can be missing
    • error_str - string - can be missing

Example:

{
    "header": {
        "target": "document.trash.RestoreDirectories",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "dir_id_list": [
                1193,
                5253,
                80983,
                912
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.trash.RestoreFile

Restore one or more files

Push information:

Pushing to: Project users
With target: document.trash.RestoreFile
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id_list - int list

Output:

  • success - bool
  • file_path_list - LIST of struct
    • success - bool
    • file_id - int
    • file_master_id - int - can be missing
    • path_ids - LIST of int - can be missing
    • error - int - can be missing
    • error_str - string - can be missing

Example:

{
    "header": {
        "target": "document.trash.RestoreFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.trash.RestoreLinks

Restore one or more links

Push information:

Pushing to: Project users
With target: document.trash.RestoreLinks
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • link_id_list - int list Optional: []

Output:

  • success - bool
  • link_path_list - LIST of struct
    • link_id - int
    • path_ids - LIST of int - can be missing

Example:

{
    "header": {
        "target": "document.trash.RestoreLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.AddValidatorsToRequest

Add validators to a doc validation request

Push information:

Pushing to: Project users
With target: document.validation.AddValidatorsToRequest
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int
  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "document.validation.AddValidatorsToRequest",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.CreateRequest

Push information:

Pushing to: Project users
With target: document.validation.CreateRequest
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int

Body Data:

  • expiry_date - datetime Optional: null
  • user_id_list - int list Optional: []
  • description - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "document.validation.CreateRequest",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {
            "expiry_date": "2016-11-27 17:10:05",
            "user_id_list": [
                12345,
                12346
            ],
            "description": "some text"
        }
    }
}

document.validation.EditRequestDescription

Edit doc validation request description

Push information:

Pushing to: Project users
With target: document.validation.EditRequestDescription
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int

Body Data:

  • description - string

Output:

Example:

{
    "header": {
        "target": "document.validation.EditRequestDescription",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345
        }
    },
    "body": {
        "data": {
            "description": "some text"
        }
    }
}

document.validation.ExportAccountValidationssAsXLS

Exports all document validations of the account as XLS

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.validation.ExportAccountValidationssAsXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ExportMyValidationAsXLS

Exports all document validation the calling user has access to as XLS

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.validation.ExportMyValidationAsXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ListRequests

List all doc validation requests for that user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.ListRequests",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ListRequestsAsRequester

List all doc validation requests associated to a requester

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.ListRequestsAsRequester",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ListRequestsAsValidator

List all doc validation requests associated to a validator

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.ListRequestsAsValidator",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ListResponses

List all doc validation responses for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.ListResponses",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.RemindValidator

send a reminder email to a validator

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int
  • response_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.validation.RemindValidator",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345,
            "response_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.RemoveRequest

Remove a doc validation request

Push information:

Pushing to: Project users
With target: document.validation.RemoveRequest
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.RemoveRequest",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.RemoveValidatorsFromRequest

Remove validators from a doc validation request

Push information:

Pushing to: Project users
With target: document.validation.RemoveValidatorsFromRequest
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int
  • response_id_list - int list

Output:

Example:

{
    "header": {
        "target": "document.validation.RemoveValidatorsFromRequest",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345,
            "response_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.ResetResponseStatus

Reset a response for a validator

Push information:

Pushing to: Project users
With target: document.validation.ResetResponseStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int
  • response_id - int

Output:

Example:

{
    "header": {
        "target": "document.validation.ResetResponseStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345,
            "response_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

document.validation.UpdateRequestExpiryDate

Update expiry date of a doc validation request

Push information:

Pushing to: Project users
With target: document.validation.UpdateRequestExpiryDate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int

Body Data:

  • expiry_date - datetime

Output:

Example:

{
    "header": {
        "target": "document.validation.UpdateRequestExpiryDate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345
        }
    },
    "body": {
        "data": {
            "expiry_date": "2016-11-27 17:10:05"
        }
    }
}

document.validation.UpdateRequestStatus

Update status of a doc validation request

Push information:

Pushing to: Project users
With target: document.validation.UpdateRequestStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int

Body Data:

  • status - int

Output:

Example:

{
    "header": {
        "target": "document.validation.UpdateRequestStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

document.validation.UpdateResponseStatus

Update a response for a validator
Possibility to write a comment for this status (will also be put in file comments)

Push information:

Pushing to: Project users
With target: document.validation.UpdateResponseStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Documents restrictions:
Read-only (1)Read-write (2)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_master_id - int
  • request_id - int
  • response_id - int

Body Data:

  • status - int
  • comment - string Optional: ""

Output:

  • success - bool
  • doc_validation_request - DocValidationRequest
  • doc_validation_response_id - int
  • doc_validation_complete - bool

Example:

{
    "header": {
        "target": "document.validation.UpdateResponseStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345,
            "request_id": 12345,
            "response_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345,
            "comment": "some text"
        }
    }
}

document.validation.exportMyRequestsAsXLS

Exports all document requests made by the calling user as XLS

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "document.validation.exportMyRequestsAsXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.AddGanttLink

Add a gantt link between two Wimi items

Push information:

Pushing to: Project users
With target: gantt.gantt.AddGanttLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • source_id - WimiItem
  • target_id - WimiItem

Body Data:

  • relation_type_id - int

Output:

  • success - bool
  • link - GanttLink
  • project_id - int - can be null

Example:

{
    "header": {
        "target": "gantt.gantt.AddGanttLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "source_id": {
                "item_type_id": "3",
                "item_id": "12345"
            },
            "target_id": {
                "item_type_id": "3",
                "item_id": "12345"
            }
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

gantt.gantt.AddGanttLinkBetweenProjects

Add a gantt link between two projects

Push information:

Pushing to: Whole account
With target: gantt.gantt.AddGanttLinkBetweenProjects
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • source_id - int
  • target_id - int

Body Data:

  • relation_type_id - int

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.AddGanttLinkBetweenProjects",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "source_id": 12346,
            "target_id": 12346
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

gantt.gantt.AddList

Add a list to gantt view
Need a line, a start date and an end date

Push information:

Pushing to: Task list users
With target: gantt.gantt.AddList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • line - int
  • start_date - date Optional: null
  • end_date - date Optional: null

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.AddList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "line": 12345,
            "start_date": "2016-11-27",
            "end_date": "2016-11-27"
        }
    }
}

gantt.gantt.BatchAddList

Add lists to gantt view
Need a line, a start date and an end date

Push information:

Pushing to: User list
With target: gantt.gantt.BatchAddList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • tasks_lists - int list

Output:

  • success - bool
  • tasks_lists - LIST of TaskList

Example:

{
    "header": {
        "target": "gantt.gantt.BatchAddList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "tasks_lists": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.BatchRemoveList

Batch remove lists from gantt view
Clean line, start date, end date and all linked links

Push information:

Pushing to: Task list users
With target: gantt.gantt.BatchRemoveList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id_list - int list

Output:

  • success - bool
  • tasks_lists - LIST of TaskList

Example:

{
    "header": {
        "target": "gantt.gantt.BatchRemoveList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.GetGanttLinks

Get all gantt links (between tasks or between lists) for a project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.GetGanttLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.GetGanttProjectIds

Get the project id list of all project that are in gantt
The projects in the gantt are the projects that have at least one list in the gantt

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • project_id_list - LIST of int

Example:

{
    "header": {
        "target": "gantt.gantt.GetGanttProjectIds",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.GetUnifiedGanttLinks

Get all gantt links (between tasks or between lists) for all the project of the account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.GetUnifiedGanttLinks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.RemoveGanttLink

Remove a gantt link between two items

Push information:

Pushing to: Project users
With target: gantt.gantt.RemoveGanttLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • source_id - WimiItem
  • target_id - WimiItem

Body Data:

  • relation_type_id - int

Output:

  • success - bool
  • link - GanttLink
  • project_id - int - can be null

Example:

{
    "header": {
        "target": "gantt.gantt.RemoveGanttLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "source_id": {
                "item_type_id": "3",
                "item_id": "12345"
            },
            "target_id": {
                "item_type_id": "3",
                "item_id": "12345"
            }
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

gantt.gantt.RemoveGanttLinkBetweenProjects

Remove a gantt link between two items

Push information:

Pushing to: Whole account
With target: gantt.gantt.RemoveGanttLinkBetweenProjects
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • source_id - int
  • target_id - int

Body Data:

  • relation_type_id - int

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.RemoveGanttLinkBetweenProjects",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "source_id": 12346,
            "target_id": 12346
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

gantt.gantt.RemoveList

Remove a list from gantt view
Clean line, start date, end date and all linked links

Push information:

Pushing to: Task list users
With target: gantt.gantt.RemoveList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Output:

Example:

{
    "header": {
        "target": "gantt.gantt.RemoveList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

gantt.gantt.ResetPlanning

Reset the gantt planning for the tasks list and tasks
If a tasks list still has dated tasks it will not be reset. Also removes the links between items

Push information:

Pushing to: Project users
With target: gantt.gantt.ResetPlanning
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • task_list_id_list - int list
  • task_id_list - int array

Output:

  • success - bool
  • task_id_list - LIST of int
  • tasks_list_id_list - LIST of int

Example:

{
    "header": {
        "target": "gantt.gantt.ResetPlanning",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "task_list_id_list": [
                12345,
                12346
            ],
            "task_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

mail.client.CreateGandiClient

Create a Gandi Client for the specified wimi account
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.client.CreateGandiClient
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • client_id - string

Example:

{
    "header": {
        "target": "mail.client.CreateGandiClient",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.domain.BuyDomain

Buy a gandi domain
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Main admins
With target: mail.domain.BuyDomain
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • domain_name - string

Output:

Example:

{
    "header": {
        "target": "mail.domain.BuyDomain",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "domain_name": "some text"
        }
    }
}

mail.domain.CreateMailbox

Create a mailbox on the current account main domain
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.domain.CreateMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.domain.CreateMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.domain.EditDomainAutoRenew

Edit a domain auto renew status
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Main admins
With target: mail.domain.EditDomainAutoRenew
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • domain_id - int

Body Data:

  • auto_renew_status - int

Output:

Example:

{
    "header": {
        "target": "mail.domain.EditDomainAutoRenew",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "domain_id": 12345
        }
    },
    "body": {
        "data": {
            "auto_renew_status": 12345
        }
    }
}

mail.domain.FetchDomainAvailability

Query gandi with domain name to check a list of available domain & their data (prices)
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.domain.FetchDomainAvailability
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • domain_name - string

Output:

  • domain_query_result - object - can be missing

Example:

{
    "header": {
        "target": "mail.domain.FetchDomainAvailability",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "domain_name": "some text"
        }
    }
}

mail.domain.FetchDomainData

Fetch domain metadata
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.domain.FetchDomainData
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • gandi_domain_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "mail.domain.FetchDomainData",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "gandi_domain_id": 12345
        }
    }
}

mail.domain.GetAccountDomains

Get all the gandi domains of the given account
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.domain.GetAccountDomains
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • domains - LIST of GandiDomain - can be null
  • client_id - string - can be null
  • mailbox_count - int - can be null

Example:

{
    "header": {
        "target": "mail.domain.GetAccountDomains",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.domain.SynchronizeDomains

Synchronize domains from GANDI & creates them in WIMI if needed
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.domain.SynchronizeDomains
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "mail.domain.SynchronizeDomains",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.ActivateResponder

Activate the automatic responder for the given mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.ActivateResponder
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Body Data:

  • responder_text - string

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.ActivateResponder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "responder_text": "some text"
        }
    }
}

mail.mailbox.AddOwnersToMailbox

Insert given users as owners of the given gandi mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.AddOwnersToMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Body Data:

  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.AddOwnersToMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id_list": [
                12345,
                12346
            ]
        }
    }
}

mail.mailbox.CreateMailbox

Create a mailbox on the current account main domain
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.CreateMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • domain_id - int

Body Data:

  • login - string

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.CreateMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "domain_id": 12345
        }
    },
    "body": {
        "data": {
            "login": "some text"
        }
    }
}

mail.mailbox.DeleteMailbox

Delete a mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.DeleteMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Output:

  • success - bool
  • mailbox_id - int
  • domain_id - int
  • status - int - can be missing

Example:

{
    "header": {
        "target": "mail.mailbox.DeleteMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.FetchDomainMailboxes

Fetch all the mailboxes associated to the account's main domain. Implemented in node3 async mode
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.FetchDomainMailboxes
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • domain_id - int

Output:

  • success - bool
  • mailboxes - LIST of Mailbox

Example:

{
    "header": {
        "target": "mail.mailbox.FetchDomainMailboxes",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "domain_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.FetchMailboxPackage

Get the mailbox package for an account
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.FetchMailboxPackage
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.FetchMailboxPackage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.FetchMailboxPackageList

Get all the available mailbox packages and the selected one (if any)
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.FetchMailboxPackageList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.FetchMailboxPackageList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.FetchMailboxesStorage

Fetch the quota storage on each mailbox of a domain
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.FetchMailboxesStorage
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • domain_id - int

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.FetchMailboxesStorage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "domain_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.FetchUserMailboxes

Fetch all the mailboxes associated to the current user. Implemented in node3 async mode
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.FetchUserMailboxes
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • mailboxes - LIST of Mailbox

Example:

{
    "header": {
        "target": "mail.mailbox.FetchUserMailboxes",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.ImportMailboxesFromCSV

Import a csv and create a list of mailboxes
Read a csv file then send a call to node async_api to create the mailboxes

Push information:

Pushing to: Main admins
With target: mail.mailbox.ImportMailboxesFromCSV
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • domain_id - int

Body Data:

  • name - string
  • size - int

Output:

  • success - bool
  • mailboxes - LIST of Mailbox

Example:

{
    "header": {
        "target": "mail.mailbox.ImportMailboxesFromCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "domain_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

mail.mailbox.PurgeMailbox

Purge the given mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.PurgeMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Output:

  • success - bool
  • mailbox_uuid - string
  • domain_id - int

Example:

{
    "header": {
        "target": "mail.mailbox.PurgeMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.RemoveOwnersFromMailbox

Activate the automatic responder for the given mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.RemoveOwnersFromMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Body Data:

  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.RemoveOwnersFromMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id_list": [
                12345,
                12346
            ]
        }
    }
}

mail.mailbox.SetMailboxPackage

Set a mailbox package for an account

Push information:

Pushing to: Self
With target: mail.mailbox.SetMailboxPackage
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • package_id - int

Output:

  • success - bool
  • package_id - int

Example:

{
    "header": {
        "target": "mail.mailbox.SetMailboxPackage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "package_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.UpdateMailbox

Push information:

Pushing to: Self
With target: mail.mailbox.UpdateMailbox
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.UpdateMailbox",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.mailbox.UpdateMailboxAliases

Update the aliases for a mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.UpdateMailboxAliases
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Body Data:

  • aliases - string list

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.UpdateMailboxAliases",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "aliases": [
                "string1",
                "string2",
                "string3"
            ]
        }
    }
}

mail.mailbox.UpdateMailboxPassword

Activate the automatic responder for the given mailbox
ONLY IMPLEMENTED IN NODE3

Push information:

Pushing to: Self
With target: mail.mailbox.UpdateMailboxPassword
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXX

Header Identification:

  • account_id - int
  • user_id - int
  • mailbox_id - int

Body Data:

  • password - string

Output:

Example:

{
    "header": {
        "target": "mail.mailbox.UpdateMailboxPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "password": "mypassword"
        }
    }
}

mail.webmail.AddWebmailAccount

Push information:

Pushing to: Self
With target: mail.webmail.AddWebmailAccount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • email - string
  • description - string
  • imap_host - string
  • imap_port - int
  • imap_login - string
  • imap_use_ssl - bool Optional: true
  • smtp_host - string
  • smtp_port - int
  • smtp_login - string
  • smtp_use_ssl - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "mail.webmail.AddWebmailAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "email": "my.email@domain.com",
            "description": "some text",
            "imap_host": "some text",
            "imap_port": 12345,
            "imap_login": "some text",
            "imap_use_ssl": true,
            "smtp_host": "some text",
            "smtp_port": 12345,
            "smtp_login": "some text",
            "smtp_use_ssl": true
        }
    }
}

mail.webmail.DeleteWebmailAccount

Push information:

Pushing to: Self
With target: mail.webmail.DeleteWebmailAccount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • email - int

Output:

  • success - bool
  • email - string

Example:

{
    "header": {
        "target": "mail.webmail.DeleteWebmailAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "email": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.webmail.GetConnectedWebmail

Push information:

Pushing to: Self
With target: mail.webmail.GetConnectedWebmail
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.webmail.GetConnectedWebmail",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.webmail.GetWebmailAccountList

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "mail.webmail.GetWebmailAccountList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

mail.webmail.SendWebmailAction

Push information:

Pushing to: Self
With target: mail.webmail.SendWebmailAction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • action - string
  • data - any Optional: stdClass Object ( )

Output:

  • action - string
  • data - object

Example:

{
    "header": {
        "target": "mail.webmail.SendWebmailAction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "action": "some text",
            "data": "no example yet"
        }
    }
}

mail.webmail.SetConnectionStatus

Push information:

Pushing to: Self
With target: mail.webmail.SetConnectionStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • is_connected - bool
  • webmail - int

Output:

Example:

{
    "header": {
        "target": "mail.webmail.SetConnectionStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "is_connected": true,
            "webmail": 12345
        }
    }
}

mail.webmail.UpdateWebmailAccount

Push information:

Pushing to: Self
With target: mail.webmail.UpdateWebmailAccount
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • email - int

Body Data:

  • description - string
  • imap_host - string
  • imap_port - int
  • imap_login - string
  • imap_use_ssl - bool Optional: true
  • smtp_host - string
  • smtp_port - int
  • smtp_login - string
  • smtp_use_ssl - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "mail.webmail.UpdateWebmailAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "email": 12345
        }
    },
    "body": {
        "data": {
            "description": "some text",
            "imap_host": "some text",
            "imap_port": 12345,
            "imap_login": "some text",
            "imap_use_ssl": true,
            "smtp_host": "some text",
            "smtp_port": 12345,
            "smtp_login": "some text",
            "smtp_use_ssl": true
        }
    }
}

main.account.AcceptUniversignGcu

Accept the Universign GCU (General Conditions of Use) for the account.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.AcceptUniversignGcu",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.ActivateCustomDepartmentList

Activate the custom department list; this means the custom list will be used instead of the default one
The list itself is back bound and not returned through the API; if it does not exist it will be created here

Push information:

Pushing to: Main admins
With target: main.account.ActivateCustomDepartmentList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.ActivateCustomDepartmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.ActivateUsers

Activate list of users

Push information:

Pushing to: Main admins
With target: main.account.ActivateUsers
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_id_list - int list

Output:

  • success - bool
  • user_id_list - LIST of int
  • errors - LIST of object - can be missing

Example:

{
    "header": {
        "target": "main.account.ActivateUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.account.AddCreditCard

Push information:

Pushing to: Main admins
With target: main.account.AddCreditCard
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • credit_card - CreditCard

Output:

Example:

{
    "header": {
        "target": "main.account.AddCreditCard",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "credit_card": {
                "number": "12345865241926312",
                "cvc": "735",
                "holder": "someone",
                "exp_year": "2018",
                "exp_month": "11"
            }
        }
    }
}

main.account.AddCredits

Push information:

Pushing to: Main admins
With target: main.account.AddCredits
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • credit_amount - float
  • credit_card - CreditCard Optional: null

Output:

  • success - bool
  • credits - int

Example:

{
    "header": {
        "target": "main.account.AddCredits",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "credit_amount": 12.345,
            "credit_card": {
                "number": "12345865241926312",
                "cvc": "735",
                "holder": "someone",
                "exp_year": "2018",
                "exp_month": "11"
            }
        }
    }
}

main.account.AddCustomDepartmentItem

Add a new item to account custom department list
The list itself is back bound and not returned through the API, the first custom department item will create the list

Push information:

Pushing to: Main admins
With target: main.account.AddCustomDepartmentItem
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • label - string

Output:

Example:

{
    "header": {
        "target": "main.account.AddCustomDepartmentItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.account.AddUser

Add a user

Push information:

Pushing to: Whole account
With target: main.account.AddUser
Stream value: Pushing on user stream (1) and on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • clone_user_id - int Optional: null
  • user_group_id_list - int list Optional: []

Body Data:

  • first_name - string
  • last_name - string
  • login - string
  • tags - array Optional: null
  • level - deprecated Optional: 1
  • role - int Optional: 0
    • - guest: -5
    • - user: 0
    • - manager: 1
    • - administrator: 2
  • language - string Optional: "en"
  • password - string Optional: null
  • gender - string Optional: "M."
  • notif_user - bool Optional: true
  • message - string Optional: ""
  • saml_id - string Optional: ""
  • company - string Optional: ""
  • department - stringEnum Optional: ""
  • title - string Optional: ""
  • custom_image_url - string Optional: ""
  • personalized_entries - PersonalizedEntryValues Optional: []
  • phones - PhoneList Optional: []
  • notify_documents_interval - int Optional: 5

Output:

Example:

{
    "header": {
        "target": "main.account.AddUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "first_name": "some text",
            "last_name": "some text",
            "login": "my.email@domain.com",
            "tags": [
                "myLabel1",
                "myLabel2"
            ],
            "level": "",
            "role": 1,
            "language": "some text",
            "password": "mypassword",
            "gender": "some text",
            "notif_user": true,
            "message": "some text",
            "saml_id": "some text",
            "company": "some text",
            "department": "value",
            "title": "some text",
            "custom_image_url": "some text",
            "personalized_entries": [
                12345,
                12346
            ],
            "phones": "no example yet",
            "notify_documents_interval": 12345
        }
    }
}

main.account.BatchUpdateUsersRole

Batch update role for user list

Push information:

Pushing to: Main admins
With target: main.account.BatchUpdateUsersRole
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_id_list - int list

Body Data:

  • role - int

Output:

  • success - bool
  • role - int
  • user_id_list - LIST of int
  • conflicts - LIST of object - can be missing

Example:

{
    "header": {
        "target": "main.account.BatchUpdateUsersRole",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "role": 12345
        }
    }
}

main.account.DeactivateCustomDepartmentList

Deactivate the custom department list; this means the default list will be used instead of the custom one

Push information:

Pushing to: Main admins
With target: main.account.DeactivateCustomDepartmentList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.DeactivateCustomDepartmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.DeactivateUsers

Deactivate list of users
Privileges of current user must be above target users

Push information:

Pushing to: Main admins
With target: main.account.DeactivateUsers
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

User restriction: API user cannot access targeted users of this route if its rank is bellow theirs.
Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_id_list - int list

Output:

  • success - bool
  • user_id_list - LIST of int
  • user_id_list_conflict - LIST of int - can be missing

Example:

{
    "header": {
        "target": "main.account.DeactivateUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.account.DeleteAccount

Delete the account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
X

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • reason - string Optional: ""
  • password - string Optional: null
  • account_name - string Optional: ""

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.DeleteAccount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "reason": "some text",
            "password": "mypassword",
            "account_name": "some text"
        }
    }
}

main.account.DeleteCustomDepartmentItem

Delete a custom item

Push information:

Pushing to: Main admins
With target: main.account.DeleteCustomDepartmentItem
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • label - string

Output:

Example:

{
    "header": {
        "target": "main.account.DeleteCustomDepartmentItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "label": "label"
        }
    },
    "body": {
        "data": {}
    }
}

main.account.DeleteUsers

Delete list of users permanently
Privileges of current user must be above target users

Push information:

Pushing to: Main admins
With target: main.account.DeleteUsers
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

User restriction: API user cannot access targeted users of this route if its rank is bellow theirs.
Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_id_list - int list

Output:

  • success - bool
  • user_id_list - LIST of int
  • user_id_list_conflict - LIST of int - can be missing

Example:

{
    "header": {
        "target": "main.account.DeleteUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.account.EditCategory

Edit a category

Push information:

Pushing to: Projets' users of a category
With target: main.account.EditCategory
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • category_id - int

Body Data:

  • category_name - string

Output:

Example:

{
    "header": {
        "target": "main.account.EditCategory",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "category_id": 12345
        }
    },
    "body": {
        "data": {
            "category_name": "some text"
        }
    }
}

main.account.EditUser

Edit a user

Push information:

Pushing to: User list
With target: main.account.EditUser
Stream value: Pushing on user stream (1) and on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

User restriction: API user cannot access targeted users of this route if its rank is bellow theirs.
Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int

Body Data:

  • phones - PhoneList Optional: []
  • first_name - string Optional: ""
  • last_name - string Optional: ""
  • login - string Optional: null
  • tags - array Optional: null
  • password - string Optional: null
  • old_password - string Optional: ""
  • role - int Optional: 0
  • gender - string Optional: "M."
  • skype - string Optional: ""
  • company - string Optional: ""
  • department - string Optional: null
  • title - string Optional: ""
  • saml_id - string Optional: ""

Output:

  • user - User
  • should_relog - bool - can be null
  • fields - LIST of string

Example:

{
    "header": {
        "target": "main.account.EditUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {
            "phones": "no example yet",
            "first_name": "some text",
            "last_name": "some text",
            "login": "my.email@domain.com",
            "tags": [
                "myLabel1",
                "myLabel2"
            ],
            "password": "mypassword",
            "old_password": "some text",
            "role": 12345,
            "gender": "some text",
            "skype": "some text",
            "company": "some text",
            "department": "label",
            "title": "some text",
            "saml_id": "some text"
        }
    }
}

main.account.ExportProjectsDiskUsageAsCsv

Export the projects disk usage for the account as a CSV file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • file_name - string Optional: "disk_usage"
  • delimiter - string Optional: ";"
  • enclosure - string Optional: """

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.ExportProjectsDiskUsageAsCsv",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "file_name": "some text",
            "delimiter": "some text",
            "enclosure": "some text"
        }
    }
}

main.account.ExportUsers

Export users in a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • file_name - string Optional: "users"
  • format - string Optional: "csv"
  • delimiter - string Optional: ";"
  • enclosure - string Optional: """
  • charset - string Optional: "UTF-8"

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.ExportUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "file_name": "some text",
            "format": "some text",
            "delimiter": "some text",
            "enclosure": "some text",
            "charset": "some text"
        }
    }
}

main.account.ExportUsersRights

Export users rights in a file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • delimiter - string Optional: ";"

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.ExportUsersRights",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "delimiter": "some text"
        }
    }
}

main.account.GenerateAPIKey

Generate an API Key for the current account
If a key is already linked to this account, generate another key

Push information:

Pushing to: Self
With target: main.account.GenerateAPIKey
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • api_key - string

Example:

{
    "header": {
        "target": "main.account.GenerateAPIKey",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.Get

Get account info

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetAccountExternalInfo

Get external information for an account
Can be used by the login page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_name - string Optional: ""

Output:

  • account_info - AccountBase
  • google_enabled - bool
  • onedrive_enabled - bool
  • onedrivepro_enabled - bool
  • sso_name - string - can be missing
  • properties - LIST of Property
  • url - string - can be missing
  • endpoints - struct
    • protocol - string
    • domain - string
    • webapp - string
    • websockets - string
    • cdn - string
    • api - string
    • api_files - string
    • files - string
    • office - string
    • airtime - string
    • zipper - string

Example:

{
    "header": {
        "target": "main.account.GetAccountExternalInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {}
    }
}

main.account.GetAccountPayingServices

Get the account paying services (available & selected with metadata)
subscription page

Push information:

Pushing to: Main admins
With target: main.account.GetAccountPayingServices
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetAccountPayingServices",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetAccountSignaturePackages

Get the account signature package list
subscription page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetAccountSignaturePackages",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetActivityRelatedRequestList

Get wapi routes that should update the activity unread counter

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • activity_request_list - LIST of string

Example:

{
    "header": {
        "target": "main.account.GetActivityRelatedRequestList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetAllAvailableUsers

Get all available users. Which mean a status will be returned.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • users - LIST of User

Example:

{
    "header": {
        "target": "main.account.GetAllAvailableUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetBillingInfo

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • offers - bool Optional: false
  • users_stats - bool Optional: false

Output:

  • billing_info - BillingInfo
  • offers - LIST of Offer - can be missing
  • users_stats - struct - can be missing
    • all - int
    • standard - struct
      • all - int
      • active - int
      • trash - int
      • deactivated - int
      • deleted - int
    • guest - struct
      • all - int
      • active - int
      • trash - int
      • deactivated - int
      • deleted - int
  • paying_services - LIST of PayingServicesAccount
  • packages - struct - can be missing

Example:

{
    "header": {
        "target": "main.account.GetBillingInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "offers": true,
            "users_stats": true
        }
    }
}

main.account.GetCalendars

Get the calendars of a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • calendars - LIST of struct
    • info - struct
      • name - string
      • calendar_id - int
      • webcal_url - string - can be null
      • ctag - int
    • user_access - int

Example:

{
    "header": {
        "target": "main.account.GetCalendars",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetCategories

Get categories of a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetCategories",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetCountryStateCode

Retrieve big object containing country & state ISO-3166-1&2 code

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • country_list - object

Example:

{
    "header": {
        "target": "main.account.GetCountryStateCode",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetCurrentSignaturePackage

Get the current signature package
subscription page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetCurrentSignaturePackage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetCustomDepartmentList

Get the account custom department list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetCustomDepartmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetDepartmentList

Get the list of department for the account
Can be default list or the custom departments list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetDepartmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetDocumentNodeCount

Return document nodes count

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • node_count - int

Example:

{
    "header": {
        "target": "main.account.GetDocumentNodeCount",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetGAppsUsers

Get gapps users and format the output to correspond the ones of Wimi

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • users - LIST of UserService - can be missing - can be null
  • url - string - can be missing

Example:

{
    "header": {
        "target": "main.account.GetGAppsUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetListOfUsersSharingSameProjects

Get list of users sharing the same projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • get_status - bool Optional: false

Output:

  • users - LIST of User

Example:

{
    "header": {
        "target": "main.account.GetListOfUsersSharingSameProjects",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "get_status": true
        }
    }
}

main.account.GetMemberListProjectsAuth

Get list of privileges on projects for a member list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • group_member_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • member_list_projects_auth - LIST of struct
    • member_id - int
    • member_type_id - int
    • projects_auth - LIST of ProjectAuth

Example:

{
    "header": {
        "target": "main.account.GetMemberListProjectsAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetMemberProjectsAuth

Get list of privileges on projects for a member

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • group_member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • member_id - int
  • member_type_id - int
  • projects_auth - LIST of ProjectAuth

Example:

{
    "header": {
        "target": "main.account.GetMemberProjectsAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetProject

Get a user project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • project_auth - bool Optional: true
  • project_stats - bool Optional: false
  • project_users - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.account.GetProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "project_auth": true,
            "project_stats": true,
            "project_users": true
        }
    }
}

main.account.GetProjectTemplates

Get the project templates for that account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetProjectTemplates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetProjects

Get projects of a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • calc_document_size - bool Optional: false
  • with_categories - bool Optional: false
  • projects_auth - bool Optional: true
  • projects_stats - bool Optional: false
  • projects_tasks_stats - bool Optional: false
  • projects_users - bool Optional: false
  • all_projects - bool Optional: true
  • include_archived - bool Optional: false

Output:

  • projects - LIST of Project
  • categories - LIST of Category - can be missing

Example:

{
    "header": {
        "target": "main.account.GetProjects",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "calc_document_size": true,
            "with_categories": true,
            "projects_auth": true,
            "projects_stats": true,
            "projects_tasks_stats": true,
            "projects_users": true,
            "all_projects": true,
            "include_archived": true
        }
    }
}

main.account.GetProjectsStats

Get projects stats for user available projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetProjectsStats",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetServiceUsers

Get the users of the given service and format the output to correspond the ones of Wimi

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • service - string

Output:

  • success - bool
  • users - LIST of UserService - can be missing
  • url - string - can be missing

Example:

{
    "header": {
        "target": "main.account.GetServiceUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text"
        }
    }
}

main.account.GetSettings

Get settings for the account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • account - Account
  • settings - AccountSettings
  • stats - struct - can be missing
    • project_active_count - int
    • project_archived_count - int
    • user_active_count - int
    • user_deactivated_count - int
    • guest_active_count - int
    • guest_deactivated_count - int
    • storage_used - int
    • storage_total - int
  • api_key - string - can be missing - can be null

Example:

{
    "header": {
        "target": "main.account.GetSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetTutorialInfo

Return the necessary info to display the welcome tutorial

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • user - User
  • skip_first_page - bool
  • show_CGU_link - bool
  • title_field_mandatory - bool
  • account - Account
  • account_settings - AccountSettings - can be missing
  • show_trial - bool
  • offer - Offer - can be missing
  • suggest_project_creation - bool
  • presets - object - can be missing

Example:

{
    "header": {
        "target": "main.account.GetTutorialInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetUniversignGcuAcceptanceStatus

Get the status of Universign GCU (General Conditions of Use) acceptance for the requested account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetUniversignGcuAcceptanceStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetUser

Get a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetUserProjectsAuth

Get list of privileges on projects for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.GetUserProjectsAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

main.account.GetUsers

Get all users

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • users - LIST of User

Example:

{
    "header": {
        "target": "main.account.GetUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.ImportGAppsUser

Import a gapps user in wimi

Push information:

Pushing to: Main admins
With target: main.account.ImportGAppsUser
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • google_id_list - string list

Output:

  • success - bool
  • users - LIST of User - can be null

Example:

{
    "header": {
        "target": "main.account.ImportGAppsUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "google_id_list": [
                "string1",
                "string2",
                "string3"
            ]
        }
    }
}

main.account.ImportUsersFromCSV

Import users from csv

Push information:

Pushing to: Main admins
With target: main.account.ImportUsersFromCSV
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • upsert - bool Optional: false
  • name - string
  • size - int

Output:

  • success - bool
  • users - LIST of User
  • errors - LIST of object

Example:

{
    "header": {
        "target": "main.account.ImportUsersFromCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "upsert": true,
            "name": "some text",
            "size": 12345
        }
    }
}

main.account.MoveCustomDepartmentItem

Move a custom item to given position

Push information:

Pushing to: Main admins
With target: main.account.MoveCustomDepartmentItem
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • label - string

Body Data:

  • position - int

Output:

Example:

{
    "header": {
        "target": "main.account.MoveCustomDepartmentItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "label": "label"
        }
    },
    "body": {
        "data": {
            "position": 12345
        }
    }
}

main.account.PayingServicesAddEntity

Add an entity of debit_type to the selected paying service
subscription page

Push information:

Pushing to: Main admins
With target: main.account.PayingServicesAddEntity
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • selected_workspace_list - int list
  • unselected_workspace_list - int list
  • paying_service_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.PayingServicesAddEntity",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "selected_workspace_list": [
                12345,
                12346
            ],
            "unselected_workspace_list": [
                12345,
                12346
            ],
            "paying_service_id": 12345
        }
    }
}

main.account.RegenerateGeneralPassword

Regenerate the password of the Wimi Backup user of this account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • password - string

Example:

{
    "header": {
        "target": "main.account.RegenerateGeneralPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.RemoveAPIKey

Remove an API Key for the current account

Push information:

Pushing to: Self
With target: main.account.RemoveAPIKey
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.RemoveAPIKey",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.RemoveCreditCard

Push information:

Pushing to: Main admins
With target: main.account.RemoveCreditCard
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • credit_card_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.account.RemoveCreditCard",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "credit_card_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.SelfDeactivate

Deactivate the current user
Manager cannot deactivate himself

Push information:

Pushing to: Main admins
With target: main.account.SelfDeactivate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • user_id - int

Example:

{
    "header": {
        "target": "main.account.SelfDeactivate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.SetBillingInfo

Set billing info of account
Each field is optional

Push information:

Pushing to: Main admins
With target: main.account.SetBillingInfo
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • bill_name - string Optional: null
  • owner - string Optional: null
  • email - string Optional: null
  • entity_type - string Optional: null
  • tva - string Optional: ""
  • address - Address Optional: null
  • phone - Phone Optional: []
  • retailer - string Optional: null
  • payment_periodicity - int Optional: 0
  • automatic_renewal - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.account.SetBillingInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "bill_name": "mylabel1",
            "owner": "mylabel1",
            "email": "my.email@domain.com",
            "entity_type": "mylabel1",
            "tva": "some text",
            "address": "no example yet",
            "phone": "no example yet",
            "retailer": "mylabel1",
            "payment_periodicity": 12345,
            "automatic_renewal": true
        }
    }
}

main.account.SetOnBoardingInfo

Set the on boarding info for the account

Push information:

Pushing to: Whole account
With target: main.account.SetOnBoardingInfo
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • company_name - string Optional: ""
  • company_size - string Optional: ""
  • welcome_invite_wish - stringEnum Optional: ""
  • welcome_activity - string Optional: ""
  • welcome_interest - int
  • entity_type - string Optional: null

Output:

Example:

{
    "header": {
        "target": "main.account.SetOnBoardingInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "company_name": "some text",
            "company_size": "some text",
            "welcome_invite_wish": "value",
            "welcome_activity": "some text",
            "welcome_interest": 12345,
            "entity_type": "mylabel1"
        }
    }
}

main.account.SetSettings

Set settings for the account

Push information:

Pushing to: Whole account
With target: main.account.SetSettings
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • company_name - string Optional: ""
  • locale_id - int Optional: 0
  • company_size - string Optional: ""
  • website - string Optional: ""
  • max_file_version - int Optional: 0
  • incoming_mail_as - string Optional: ""
  • admin_user_creation_disabled - bool Optional: false
  • admin_category_creation_disabled - bool Optional: false
  • admin_group_creation_disabled - bool Optional: false
  • sharing_actions_disabled - bool Optional: false
  • auto_trash_deletion - bool Optional: false
  • tag_creation_disabled - bool Optional: false
  • community_creation_min_privilege - int Optional: 0
  • mail_upload_disabled - bool Optional: false
  • password_policy - bool Optional: false
  • doc_notif_type - int Optional: 1
  • default_project_quota - int Optional: 0
  • interest - int Optional: 0
  • allow_support_intervention - bool Optional: false
  • welcome_invite_wish - stringEnum Optional: ""
  • manager_visibility_rights - int Optional: 1
  • user_visibility_option - int Optional: 0
  • activity_min_privilege - int Optional: 0
  • airtime_creation_min_privilege - int Optional: 0
  • admin_user_creation_max_privilege - int Optional: 1
  • remove_logo - bool Optional: false
  • name - string Optional: ""
  • size - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "main.account.SetSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "company_name": "some text",
            "locale_id": 12345,
            "company_size": "some text",
            "website": "some text",
            "max_file_version": 12345,
            "incoming_mail_as": "some text",
            "admin_user_creation_disabled": true,
            "admin_category_creation_disabled": true,
            "admin_group_creation_disabled": true,
            "sharing_actions_disabled": true,
            "auto_trash_deletion": true,
            "tag_creation_disabled": true,
            "community_creation_min_privilege": 12345,
            "mail_upload_disabled": true,
            "password_policy": true,
            "doc_notif_type": 12345,
            "default_project_quota": 12345,
            "interest": 12345,
            "allow_support_intervention": true,
            "welcome_invite_wish": "value",
            "manager_visibility_rights": 12345,
            "user_visibility_option": 12345,
            "activity_min_privilege": 12345,
            "airtime_creation_min_privilege": 12345,
            "admin_user_creation_max_privilege": 12345,
            "remove_logo": true,
            "name": "some text",
            "size": 12345
        }
    }
}

main.account.SetUISetting

Customization - set ui settings
setting_key can be one of: ui_setting_main_bg_color, ui_setting_welcome_text, ui_setting_welcome_image, ui_setting_header_image. Either setting_value or a file should be provided

Push information:

Pushing to: Whole account
With target: main.account.SetUISetting
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • setting_key - string
  • setting_value - string Optional: ""
  • name - string Optional: ""
  • size - int Optional: 0

Output:

  • settings - struct
    • ui_setting_main_color - int
    • ui_setting_welcome_text - string - can be null
    • ui_setting_welcome_image - string - can be null
    • ui_setting_header_image - string - can be null
    • ui_setting_saml_login_text - string - can be null
    • ui_setting_invite_mail - string - can be null

Example:

{
    "header": {
        "target": "main.account.SetUISetting",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "setting_key": "some text",
            "setting_value": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

main.account.SetWelcomeActivity

Set welcome activity
Set welcome activity

Push information:

Pushing to: Self
With target: main.account.SetWelcomeActivity
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
X

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • welcome_activity - string Optional: ""
  • welcome_interest - int

Output:

  • success - bool
  • welcome_activity - string - can be missing
  • welcome_interest - int

Example:

{
    "header": {
        "target": "main.account.SetWelcomeActivity",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "welcome_activity": "some text",
            "welcome_interest": 12345
        }
    }
}

main.account.ShouldPerformPayment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • should_perform_payment - bool

Example:

{
    "header": {
        "target": "main.account.ShouldPerformPayment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.SubscribeToSignaturePackage

Subscribe to a signature package
subscription page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • signature_package_id - int

Output:

Example:

{
    "header": {
        "target": "main.account.SubscribeToSignaturePackage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "signature_package_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.ToggleSupportInterventionAuthorization

Toggle support intervention authorization on account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
X

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • allow_support_intervention - bool

Example:

{
    "header": {
        "target": "main.account.ToggleSupportInterventionAuthorization",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.ToggleThirdPartyService

Enable/Disable a third party service for the account

Push information:

Pushing to: Whole account
With target: main.account.ToggleThirdPartyService
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • service - string
  • enable - bool

Output:

  • service - string
  • enabled - bool

Example:

{
    "header": {
        "target": "main.account.ToggleThirdPartyService",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text",
            "enable": true
        }
    }
}

main.account.UnsubscribeToSignaturePackage

Subscribe to a signature package
subscription page

Push information:

Pushing to: Self
With target: main.account.UnsubscribeToSignaturePackage
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • deletion_date - date - can be missing

Example:

{
    "header": {
        "target": "main.account.UnsubscribeToSignaturePackage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.account.UpdateCustomDepartmentItem

Add a new item to account custom department list
The list itself is back bound and not returned through the API, the first custom department item will create the list

Push information:

Pushing to: Main admins
With target: main.account.UpdateCustomDepartmentItem
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • label - string
  • new_label - string

Output:

Example:

{
    "header": {
        "target": "main.account.UpdateCustomDepartmentItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "label": "label",
            "new_label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.appli.GetWebappVersion

Get the webapp version

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

Output:

  • webapp_version - string

Example:

{
    "header": {
        "target": "main.appli.GetWebappVersion",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {}
    }
}

main.group.AddMember

Add a member to a group

Push information:

Pushing to: Unkown push action
With target: main.group.AddMember
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Body Data:

  • group_member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

Example:

{
    "header": {
        "target": "main.group.AddMember",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    }
}

main.group.AddTag

Add a tag on a user group

Push information:

Pushing to: Unkown push action
With target: main.group.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int
  • label - string

Output:

  • success - bool
  • user_group_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.group.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.group.BatchAddMembers

Batch add members to a group

Push information:

Pushing to: Unkown push action
With target: main.group.BatchAddMembers
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Body Data:

  • group_member_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

Example:

{
    "header": {
        "target": "main.group.BatchAddMembers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    }
}

main.group.Create

Create a user group

Push information:

Pushing to: User list
With target: main.group.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • group_member_list - array Optional: null
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

Example:

{
    "header": {
        "target": "main.group.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "group_member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    }
}

main.group.Delete

Delete a user group

Push information:

Pushing to: User list
With target: main.group.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Output:

Example:

{
    "header": {
        "target": "main.group.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.group.Edit

Edit a user group

Push information:

Pushing to: Unkown push action
With target: main.group.Edit
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Body Data:

  • name - string

Output:

Example:

{
    "header": {
        "target": "main.group.Edit",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1"
        }
    }
}

main.group.EditGroupCreationUser

Edit a group creation user

Push information:

Pushing to: Unkown push action
With target: main.group.EditGroupCreationUser
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Body Data:

  • creation_user_id - int

Output:

Example:

{
    "header": {
        "target": "main.group.EditGroupCreationUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "creation_user_id": 12346
        }
    }
}

main.group.LinkTag

Link a tag to a group

Push information:

Pushing to: Unkown push action
With target: main.group.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int
  • tag_id - int

Output:

  • success - bool
  • user_group_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.group.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.group.List

List the user group of this account
limited to what the user can see

Push information:

Pushing to: Unkown push action
With target: main.group.List
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • user_group_list - LIST of UserGroup

Example:

{
    "header": {
        "target": "main.group.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.group.RemoveMember

Remove a member from a group

Push information:

Pushing to: Unkown push action
With target: main.group.RemoveMember
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int

Body Data:

  • group_member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

Example:

{
    "header": {
        "target": "main.group.RemoveMember",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    }
}

main.group.RemoveTag

Remove a tag in a user group

Push information:

Pushing to: Unkown push action
With target: main.group.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int
  • tag_id - int

Output:

  • success - bool
  • user_group_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.group.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.group.RemoveTagByLabel

Remove a tag in a user group using the label

Push information:

Pushing to: Unkown push action
With target: main.group.RemoveTagByLabel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • user_group_id - int
  • label - string

Output:

  • success - bool
  • user_group_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.group.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.personalizedentry.AddChoice

add a choice to a personalized entry of type qcu / qcm

Push information:

Pushing to: Whole account
With target: main.personalizedentry.AddChoice
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • label - string

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.AddChoice",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "label": "some text"
        }
    }
}

main.personalizedentry.BatchUpdateEntryAccess

Insert object access for specified entry (workspace/users)

Push information:

Pushing to: Whole account
With target: main.personalizedentry.BatchUpdateEntryAccess
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id_list - int list
  • object - string
  • auth - bool

Output:

  • success - bool
  • entry_id_list - LIST of int
  • object - string
  • auth - bool

Example:

{
    "header": {
        "target": "main.personalizedentry.BatchUpdateEntryAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id_list": [
                12345,
                12346
            ],
            "object": "some text",
            "auth": true
        }
    }
}

main.personalizedentry.BatchUpdateEntryProjectAuth

change entry access to workspace (module)

Push information:

Pushing to: Whole account
With target: main.personalizedentry.BatchUpdateEntryProjectAuth
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • project_id - int
  • entry_id_list - int list
  • documents - int Optional: -1
  • tasks - int Optional: -1

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.BatchUpdateEntryProjectAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "project_id": 12346,
            "entry_id_list": [
                12345,
                12346
            ],
            "documents": 1,
            "tasks": 1
        }
    }
}

main.personalizedentry.Create

create a personalized entry

Push information:

Pushing to: Whole account
With target: main.personalizedentry.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • type_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "type_id": 12345
        }
    }
}

main.personalizedentry.DeleteChoice

remove a choice

Push information:

Pushing to: Whole account
With target: main.personalizedentry.DeleteChoice
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • choice_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.DeleteChoice",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "choice_id": 12346
        }
    }
}

main.personalizedentry.DeleteEntries

Batch delete entries

Push information:

Pushing to: Whole account
With target: main.personalizedentry.DeleteEntries
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id_list - int list

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.DeleteEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id_list": [
                12345,
                12346
            ]
        }
    }
}

main.personalizedentry.GetEntryGlobalAccess

get workspace / module access of an entry

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.GetEntryGlobalAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346
        }
    }
}

main.personalizedentry.GetItemEntries

Get item entries and their value

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • item_id - int
  • item_type_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.GetItemEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "item_id": 12345,
            "item_type_id": 12345
        }
    }
}

main.personalizedentry.GetPersonalizedEntries

get a personalized entry

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.GetPersonalizedEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.personalizedentry.GetPersonalizedEntriesForObject

get a personalized entries for users

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • object_type - string

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.GetPersonalizedEntriesForObject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "object_type": "some text"
        }
    }
}

main.personalizedentry.GetWorkspaceEntryAccess

get specific workspace / module access of an entry

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.GetWorkspaceEntryAccess",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.personalizedentry.MoveChoice

Move a choice to another position

Push information:

Pushing to: Whole account
With target: main.personalizedentry.MoveChoice
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • choice_id - int
  • position - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.MoveChoice",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "choice_id": 12346,
            "position": 12345
        }
    }
}

main.personalizedentry.MoveEntry

Move a choice to another position

Push information:

Pushing to: Whole account
With target: main.personalizedentry.MoveEntry
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • new_position - int

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.MoveEntry",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "new_position": 12345
        }
    }
}

main.personalizedentry.RenameChoice

add a choice to a personalized entry of type qcu / qcm

Push information:

Pushing to: Whole account
With target: main.personalizedentry.RenameChoice
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • choice_id - int
  • label - string

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.RenameChoice",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "choice_id": 12346,
            "label": "some text"
        }
    }
}

main.personalizedentry.SetEntryValue

Set value for the specified entry

Push information:

Pushing to: Whole account
With target: main.personalizedentry.SetEntryValue
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • item_id - int
  • item_type_id - int
  • raw_value - string Optional: ""
  • choice_id - int Optional: null
  • choice_status - bool Optional: false

Output:

  • item_entries - LIST of PersonalizedEntryValue - can be missing
  • entry_id - int
  • item_id - int
  • item_type_id - int
  • success - bool

Example:

{
    "header": {
        "target": "main.personalizedentry.SetEntryValue",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "item_id": 12345,
            "item_type_id": 12345,
            "raw_value": "some text",
            "choice_id": 12346,
            "choice_status": true
        }
    }
}

main.personalizedentry.UpdateName

Update name of an entry

Push information:

Pushing to: Whole account
With target: main.personalizedentry.UpdateName
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • entry_id - int
  • name - string

Output:

Example:

{
    "header": {
        "target": "main.personalizedentry.UpdateName",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12346,
            "name": "some text"
        }
    }
}

main.project.ActivateModules

Activate modules on a project

Push information:

Pushing to: Project users
With target: main.project.ActivateModules
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • modules - string list

Output:

Example:

{
    "header": {
        "target": "main.project.ActivateModules",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "modules": [
                "string1",
                "string2",
                "string3"
            ]
        }
    }
}

main.project.AddTag

Add a tag on a project

Push information:

Pushing to: Project users
With target: main.project.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • label - string

Output:

  • success - bool
  • project_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.project.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.project.Archive

Archive a project

Push information:

Pushing to: Project users and main admins
With target: main.project.Archive
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "main.project.Archive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.BatchSetUsersAuth

Set the auth on a project for a list of users
Used to add a user list to a project and deal with its module access or with its admin level

Push information:

Pushing to: User list
With target: main.project.BatchSetUsersAuth
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • target_user_id_list - int list

Body Data:

  • level - int Optional: -1 - Set the project admin level : 0 not admin, 5 admin
  • documents - int Optional: -1 - Set the documents access level: 0 no access, 1 read only, 2 full access
  • tasks - int Optional: -1 - Set the tasks access level: 0 no access, 1 own tasks only, 2 full access
  • calendar - int Optional: -1 - Set the calendar access level: 0 no access, 1 read only, 2 full access without acceptance right, 3 full access with acceptance right
  • meetings - int Optional: -1 - Set the meetings access level: 0 no access, 1 full access
  • reporting - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • channel - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • notif_user - bool Optional: true

Output:

  • success - bool
  • user_id_list - LIST of int
  • project - Project
  • project_auth - LIST of ProjectAuth

Example:

{
    "header": {
        "target": "main.project.BatchSetUsersAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "target_user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "level": 1,
            "documents": 1,
            "tasks": 1,
            "calendar": 1,
            "meetings": 1,
            "reporting": 1,
            "channel": 1,
            "notif_user": true
        }
    }
}

main.project.Create

Push information:

Pushing to: User list
With target: main.project.Create
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • api_key - string Optional: ""
  • clone_project_id - int Optional: null

Body Data:

  • project_name - string
  • category_id - int Optional: 0
  • new_category_name - string Optional: ""
  • no_email - bool Optional: false
  • email_prefix - string Optional: ""
  • info - string Optional: ""
  • url_image - string Optional: ""
  • template_key - string Optional: ""
  • clone_directories - bool Optional: true
  • clone_files - bool Optional: true
  • clone_tasks - bool Optional: true
  • business_hour_start_datetime - datetime Optional: null
  • business_hour_end_datetime - datetime Optional: null
  • business_hour_enable_weekend - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "main.project.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "project_name": "some text",
            "category_id": 12345,
            "new_category_name": "some text",
            "no_email": true,
            "email_prefix": "some text",
            "info": "some text",
            "url_image": "some text",
            "template_key": "some text",
            "clone_directories": true,
            "clone_files": true,
            "clone_tasks": true,
            "business_hour_start_datetime": "2016-11-27 17:10:05",
            "business_hour_end_datetime": "2016-11-27 17:10:05",
            "business_hour_enable_weekend": 12345
        }
    }
}

main.project.CreateFromTemplate

Create a project given a template
Will copy everything: messages, docs, tasks, events, ... and make the current manager as creator for everything

Push information:

Pushing to: User list
With target: main.project.CreateFromTemplate
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_project_id - int

Body Data:

  • project_name - string Optional: ""
  • category_id - int Optional: 0
  • new_category_name - string Optional: ""
  • info - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "main.project.CreateFromTemplate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_project_id": 12345
        }
    },
    "body": {
        "data": {
            "project_name": "some text",
            "category_id": 12345,
            "new_category_name": "some text",
            "info": "some text"
        }
    }
}

main.project.DeactivateModules

Deactivate modules on a project

Push information:

Pushing to: Project users
With target: main.project.DeactivateModules
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • modules - string list

Output:

Example:

{
    "header": {
        "target": "main.project.DeactivateModules",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "modules": [
                "string1",
                "string2",
                "string3"
            ]
        }
    }
}

main.project.Delete

Delete a project definitely

Push information:

Pushing to: Project users and main admins
With target: main.project.Delete
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • project_id - int

Example:

{
    "header": {
        "target": "main.project.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.GetProjectTagCountInFamily

Push information:

Pushing to: Project users
With target: main.project.GetProjectTagCountInFamily
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • family_tag_id - int
  • add_family_if_no_tag - bool

Output:

  • tag_count - int
  • project - Project - can be null

Example:

{
    "header": {
        "target": "main.project.GetProjectTagCountInFamily",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "family_tag_id": 12345,
            "add_family_if_no_tag": true
        }
    }
}

main.project.GetTemplateList

Get list of templates for this account / user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.project.GetTemplateList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.GetUsersAuth

Get list of all users auth on that project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • full - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.project.GetUsersAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "full": true
        }
    }
}

main.project.GetUsersList

Get list of all users in a project (via user_id)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • full - bool Optional: false

Output:

  • users - LIST of User

Example:

{
    "header": {
        "target": "main.project.GetUsersList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "full": true
        }
    }
}

main.project.IsServiceAvailableForProject

Check whether project has specified paying service enabled. adds the access if add_paying_service is set to true

Push information:

Pushing to: Project users
With target: main.project.IsServiceAvailableForProject
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • add_paying_service - bool
  • paying_service - string

Output:

  • enabled - bool

Example:

{
    "header": {
        "target": "main.project.IsServiceAvailableForProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "add_paying_service": true,
            "paying_service": "some text"
        }
    }
}

main.project.LinkTag

Link a tag to a project

Push information:

Pushing to: Project users
With target: main.project.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • tag_id - int

Output:

  • success - bool
  • project_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.project.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.LockProjectTree

Lock a project tree
It is impossible to create, modify or move folders within a locked project tree

Push information:

Pushing to: Project users
With target: main.project.LockProjectTree
Stream value: Pushing on document stream (8)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.project.LockProjectTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.RemoveTag

Remove a tag in a project

Push information:

Pushing to: Project users
With target: main.project.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • tag_id - int

Output:

  • success - bool
  • project_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.project.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.RemoveTagByLabel

Remove a tag in a project using the label

Push information:

Pushing to: Project users
With target: main.project.RemoveTagByLabel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • label - string

Output:

  • success - bool
  • project_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.project.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.project.RemoveTagFamilyRestriction

Remove tag family restriction

Push information:

Pushing to: Project users
With target: main.project.RemoveTagFamilyRestriction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "main.project.RemoveTagFamilyRestriction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.RemoveUserGroups

Removes user groups from a project

Push information:

Pushing to: User list
With target: main.project.RemoveUserGroups
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • user_group_id_list - int list

Output:

  • success - bool
  • user_group_id_list - LIST of int
  • project_id - int

Example:

{
    "header": {
        "target": "main.project.RemoveUserGroups",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "user_group_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.project.RemoveUsers

Removes users from a project

Push information:

Pushing to: User list
With target: main.project.RemoveUsers
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • user_id_list - int list

Output:

  • success - bool
  • user_id_list - LIST of int
  • project_id - int

Example:

{
    "header": {
        "target": "main.project.RemoveUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.project.ReplaceUser

Replace a user in another in a project

Push information:

Pushing to: User list
With target: main.project.ReplaceUser
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • user_source_id - int
  • user_target_id - int

Output:

Example:

{
    "header": {
        "target": "main.project.ReplaceUser",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "user_source_id": 12346,
            "user_target_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}

main.project.Restore

Unarchive a project

Push information:

Pushing to: Project users and main admins
With target: main.project.Restore
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "main.project.Restore",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.SetDriveSync

Enable/Disable the drive synchronisation for all users

Push information:

Pushing to: Project users
With target: main.project.SetDriveSync
Stream value: Pushing on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • enable - bool

Output:

Example:

{
    "header": {
        "target": "main.project.SetDriveSync",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "enable": true
        }
    }
}

main.project.SetMemberAuth

Set the member auth on a project
Used to add a member to a project and deal with its module access or with its admin level

Push information:

Pushing to: User list
With target: main.project.SetMemberAuth
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • group_member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Body Data:

  • level - int Optional: -1 - Set the project admin level : 0 not admin, 5 admin
  • documents - int Optional: -1 - Set the documents access level: 0 no access, 1 read only, 2 full access
  • tasks - int Optional: -1 - Set the tasks access level: 0 no access, 1 own tasks only, 2 full access
  • calendar - int Optional: -1 - Set the calendar access level: 0 no access, 1 read only, 2 full access
  • meetings - int Optional: -1 - Set the meetings access level: 0 no access, 1 full access
  • reporting - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • channel - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • notif_user - bool Optional: true

Output:

  • success - bool
  • member_id - int
  • member_type_id - int
  • project - Project
  • project_auth - ProjectAuth

Example:

{
    "header": {
        "target": "main.project.SetMemberAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {
            "level": 1,
            "documents": 1,
            "tasks": 1,
            "calendar": 1,
            "meetings": 1,
            "reporting": 1,
            "channel": 1,
            "notif_user": true
        }
    }
}

main.project.SetTagFamilyRestriction

Set tag family restriction

Push information:

Pushing to: Project users
With target: main.project.SetTagFamilyRestriction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • family_tag_id - int
  • action - int

Output:

  • success - bool
  • tag_ids - LIST of int
  • project - Project

Example:

{
    "header": {
        "target": "main.project.SetTagFamilyRestriction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "family_tag_id": 12345,
            "action": 12345
        }
    }
}

main.project.SetUserAuth

Set the user auth on a project
Used to add a user to a project and deal with its module access or with its admin level

Push information:

Pushing to: User list
With target: main.project.SetUserAuth
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • target_user_id - int
  • adding_user - bool Optional: false

Body Data:

  • level - int Optional: -1 - Set the project admin level : 0 not admin, 5 admin
  • documents - int Optional: -1 - Set the documents access level: 0 no access, 1 read only, 2 full access
  • tasks - int Optional: -1 - Set the tasks access level: 0 no access, 1 own tasks only, 2 full access
  • calendar - int Optional: -1 - Set the calendar access level: 0 no access, 1 read only, 2 full access without acceptance right, 3 full access with acceptance right
  • meetings - int Optional: -1 - Set the meetings access level: 0 no access, 1 full access
  • reporting - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • channel - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • notif_user - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "main.project.SetUserAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {
            "level": 1,
            "documents": 1,
            "tasks": 1,
            "calendar": 1,
            "meetings": 1,
            "reporting": 1,
            "channel": 1,
            "notif_user": true
        }
    }
}

main.project.SetUserGroupAuth

Set the user group auth on a project
Used to add a group to a project and deal with its module access

Push information:

Pushing to: Unkown push action
With target: main.project.SetUserGroupAuth
Stream value: Pushing on user stream (1) and on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Advanced project restrictions:
General administrators (account role: 2)Project managers (project rights: 5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • user_group_id - int

Body Data:

  • level - int Optional: -1 - Set the project admin level : 0 not admin, 5 admin
  • documents - int Optional: -1 - Set the documents access level: 0 no access, 1 read only, 2 full access
  • tasks - int Optional: -1 - Set the tasks access level: 0 no access, 1 own tasks only, 2 full access
  • calendar - int Optional: -1 - Set the calendar access level: 0 no access, 1 read only, 2 full access
  • meetings - int Optional: -1 - Set the meetings access level: 0 no access, 1 full access
  • reporting - int Optional: -1 - Set the documents access level: 0 no access, 1 full access
  • channel - int Optional: -1 - Set the documents access level: 0 no access, 1 full access

Output:

Example:

{
    "header": {
        "target": "main.project.SetUserGroupAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "level": 1,
            "documents": 1,
            "tasks": 1,
            "calendar": 1,
            "meetings": 1,
            "reporting": 1,
            "channel": 1
        }
    }
}

main.project.UnlockProjectTree

Unlock a project tree
It is impossible to create, modify or move folders within a locked project tree

Push information:

Pushing to: Project users
With target: main.project.UnlockProjectTree
Stream value: Pushing on document stream (8)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.project.UnlockProjectTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.project.Update

Push information:

Pushing to: Project users
With target: main.project.Update
Stream value: Pushing on user stream (1) and on chat stream (2) and on document stream (8) and on document tree stream (16)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • api_key - string Optional: ""

Body Data:

  • project_name - string Optional: ""
  • category_id - int Optional: 0
  • new_category_name - string Optional: ""
  • email_prefix - string Optional: ""
  • url_image - string Optional: ""
  • refresh_default_image - bool Optional: false
  • storage_quota - int Optional: 0
  • business_hour_start_datetime - datetime Optional: null
  • business_hour_end_datetime - datetime Optional: null
  • business_hour_enable_weekend - int Optional: 0
  • name - string Optional: ""
  • info - string Optional: ""
  • size - int Optional: 0
  • end_date - date Optional: null
  • start_date - date Optional: null

Output:

Example:

{
    "header": {
        "target": "main.project.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "project_name": "some text",
            "category_id": 12345,
            "new_category_name": "some text",
            "email_prefix": "some text",
            "url_image": "some text",
            "refresh_default_image": true,
            "storage_quota": 12345,
            "business_hour_start_datetime": "2016-11-27 17:10:05",
            "business_hour_end_datetime": "2016-11-27 17:10:05",
            "business_hour_enable_weekend": 12345,
            "name": "some text",
            "info": "some text",
            "size": 12345,
            "end_date": "2016-11-27",
            "start_date": "2016-11-27"
        }
    }
}

main.project.UpdateDefaultModule

Update default module

Push information:

Pushing to: Project users
With target: main.project.UpdateDefaultModule
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
X

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • module - string

Output:

Example:

{
    "header": {
        "target": "main.project.UpdateDefaultModule",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "module": "some text"
        }
    }
}

main.saml.CreateServiceToken

Create a token that can be used by an external service to create a limited access token for that user
Need a SAML access token: the user will be fetched by contacting the IdP

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • access_token - string

Body Data:

  • service_name - string - Name of the service associated to that token

Output:

  • service_token - string

Example:

{
    "header": {
        "target": "main.saml.CreateServiceToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "access_token": "mylabel1"
        }
    },
    "body": {
        "data": {
            "service_name": "mylabel1"
        }
    }
}

main.saml.GetAccountList

Get a list of account associated to the user linked to the given access token
Need a SAML access token: the user will be fetched by contacting the IdP

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • access_token - string

Output:

Example:

{
    "header": {
        "target": "main.saml.GetAccountList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "access_token": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.session.Load

Load some info about the session

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • all_account_projects - bool Optional: false
  • projects_auth - bool Optional: true
  • projects_stats - bool Optional: true
  • projects_tasks_stats - bool Optional: false
  • projects_users - bool Optional: false
  • users_trashed - bool Optional: false
  • users_deleted - bool Optional: false
  • tags - bool Optional: false
  • offer - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.session.Load",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "all_account_projects": true,
            "projects_auth": true,
            "projects_stats": true,
            "projects_tasks_stats": true,
            "projects_users": true,
            "users_trashed": true,
            "users_deleted": true,
            "tags": true,
            "offer": true
        }
    }
}

main.session.LoadExtra

Load some info about the session

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • tags - bool Optional: false
  • offer - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.session.LoadExtra",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "tags": true,
            "offer": true
        }
    }
}

main.session.LoadProjects

Getting all projects the user has access to and their information

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • all_account_projects - bool Optional: false
  • projects_auth - bool Optional: true
  • projects_stats - bool Optional: true
  • projects_tasks_stats - bool Optional: false
  • projects_users - bool Optional: false
  • page - int Optional: 1

Output:

Example:

{
    "header": {
        "target": "main.session.LoadProjects",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "all_account_projects": true,
            "projects_auth": true,
            "projects_stats": true,
            "projects_tasks_stats": true,
            "projects_users": true,
            "page": 12345
        }
    }
}

main.session.LoadUsers

Getting all users the user can see and their information

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • users_trashed - bool Optional: false
  • users_deleted - bool Optional: false
  • page - int Optional: 1

Output:

Example:

{
    "header": {
        "target": "main.session.LoadUsers",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "users_trashed": true,
            "users_deleted": true,
            "page": 12345
        }
    }
}

main.session.Ping

Ping
Will force an update on the given token ttl.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • pong - bool

Example:

{
    "header": {
        "target": "main.session.Ping",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.AddTagsToFamilies

Add a list of tags to a list of tag families

Push information:

Pushing to: Whole account
With target: main.tag.AddTagsToFamilies
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • tags - int list
  • family_tags - int list

Output:

  • success - bool
  • tags - LIST of Tag
  • family_tag_id_list - LIST of int

Example:

{
    "header": {
        "target": "main.tag.AddTagsToFamilies",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "tags": [
                12345,
                12346
            ],
            "family_tags": [
                12345,
                12346
            ]
        }
    }
}

main.tag.BatchMergeTags

merge several tags into another
only the kept tag is returned

Push information:

Pushing to: Whole account
With target: main.tag.BatchMergeTags
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id_to_keep - int
  • tag_id_list_to_merge - int list

Output:

  • success - bool
  • tag - Tag
  • merged_tags - LIST of Tag

Example:

{
    "header": {
        "target": "main.tag.BatchMergeTags",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id_to_keep": 12345,
            "tag_id_list_to_merge": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.BatchRemove

remove several tags

Push information:

Pushing to: Whole account
With target: main.tag.BatchRemove
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id_list - int list

Output:

  • success - bool
  • tags - LIST of Tag

Example:

{
    "header": {
        "target": "main.tag.BatchRemove",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.ChangeColor

Change the color of a tag
Color must be int between 0 and 7

Push information:

Pushing to: Whole account
With target: main.tag.ChangeColor
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id - int

Body Data:

  • color - int

Output:

  • success - bool
  • tag - Tag

Example:

{
    "header": {
        "target": "main.tag.ChangeColor",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {
            "color": 12345
        }
    }
}

main.tag.Create

create a tag

Push information:

Pushing to: Whole account
With target: main.tag.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • label - string
  • color - int Optional: 3

Output:

Example:

{
    "header": {
        "target": "main.tag.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1",
            "color": 12345
        }
    }
}

main.tag.CreateFamily

create a family tag

Push information:

Pushing to: Whole account
With target: main.tag.CreateFamily
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • family_tag - string

Output:

Example:

{
    "header": {
        "target": "main.tag.CreateFamily",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "family_tag": "mylabel1"
        }
    }
}

main.tag.Get

get a tag

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id - int

Output:

Example:

{
    "header": {
        "target": "main.tag.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.GetAll

get all tags for this account

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • tags - LIST of Tag

Example:

{
    "header": {
        "target": "main.tag.GetAll",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.GetByLabel

get a tag by its label

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • label - string

Output:

  • tag - Tag - can be missing

Example:

{
    "header": {
        "target": "main.tag.GetByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1"
        }
    }
}

main.tag.GetFamilyTags

get a family tag

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • family_tags - LIST of TagFamily

Example:

{
    "header": {
        "target": "main.tag.GetFamilyTags",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.GetStats

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.tag.GetStats",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.ImportFromCSV

Import tags from csv

Push information:

Pushing to: Whole account
With target: main.tag.ImportFromCSV
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • size - int

Output:

  • success - bool
  • family_tag - LIST of TagFamily
  • tags - LIST of Tag
  • errors - LIST of object

Example:

{
    "header": {
        "target": "main.tag.ImportFromCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

main.tag.MergeTags

merge one tag into another
only the kept tag is returned

Push information:

Pushing to: Whole account
With target: main.tag.MergeTags
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id_to_keep - int
  • tag_id_to_merge - int

Output:

  • success - bool
  • tag - Tag
  • merged_tag - Tag

Example:

{
    "header": {
        "target": "main.tag.MergeTags",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id_to_keep": 12345,
            "tag_id_to_merge": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.Remove

remove a tag (globally)

Push information:

Pushing to: Whole account
With target: main.tag.Remove
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id - int

Output:

  • success - bool
  • tag - Tag

Example:

{
    "header": {
        "target": "main.tag.Remove",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.tag.RemoveFamilyTag

remove a family tag tag

Push information:

Pushing to: Whole account
With target: main.tag.RemoveFamilyTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • family_tag - int

Output:

  • success - bool
  • family_tag_removed - TagFamily

Example:

{
    "header": {
        "target": "main.tag.RemoveFamilyTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "family_tag": 12345
        }
    }
}

main.tag.RemoveTagsFromFamily

Remove a list of tags from a family

Push information:

Pushing to: Whole account
With target: main.tag.RemoveTagsFromFamily
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • tags - int list
  • family_id - int

Output:

  • success - bool
  • tag_id_list - LIST of int
  • tag_family_id - int

Example:

{
    "header": {
        "target": "main.tag.RemoveTagsFromFamily",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "tags": [
                12345,
                12346
            ],
            "family_id": 12345
        }
    }
}

main.tag.Rename

Push information:

Pushing to: Whole account
With target: main.tag.Rename
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • tag_id - int

Body Data:

  • label - string

Output:

  • success - bool
  • tag - Tag

Example:

{
    "header": {
        "target": "main.tag.Rename",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1"
        }
    }
}

main.tag.UpdateFamily

update a family tag

Push information:

Pushing to: Whole account
With target: main.tag.UpdateFamily
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • label - string
  • family_tag - int

Output:

Example:

{
    "header": {
        "target": "main.tag.UpdateFamily",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1",
            "family_tag": 12345
        }
    }
}

main.user.AddTag

Add a tag on a user

Push information:

Pushing to: Unkown push action
With target: main.user.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int
  • label - string

Output:

  • success - bool
  • user_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.user.BatchLinkTag

Link a tag to a list of user

Push information:

Pushing to: Unkown push action
With target: main.user.BatchLinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id_list - int list
  • tag_id - int

Output:

  • success - bool
  • user_id_list - LIST of int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.BatchLinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id_list": [
                12345,
                12346
            ],
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.BatchRemoveTag

Remove a tag in a list of users

Push information:

Pushing to: Unkown push action
With target: main.user.BatchRemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id_list - int list
  • tag_id - int

Output:

  • success - bool
  • user_id_list - LIST of int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.BatchRemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id_list": [
                12345,
                12346
            ],
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.BatchUpdateProperty

Push information:

Pushing to: Self
With target: main.user.BatchUpdateProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • user_property_list - array

Output:

Example:

{
    "header": {
        "target": "main.user.BatchUpdateProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "user_property_list": [
                {
                    "property_type_id": 12345,
                    "property_value": "my value",
                    "project_id": 12345
                },
                {
                    "property_type_id": 12345,
                    "property_value": "my value",
                    "project_id": 12345
                }
            ]
        }
    }
}

main.user.CreateLimitedTokenForService

Create a token with restricted accesses for a specific service
The created token is only valid for 5 minutes

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

Body Data:

  • service_secret - string - secret used to identify the calling service
  • service_token - string - user service token
  • api_list - string list - list of the apis allowed for the generated token

Output:

  • token - string

Example:

{
    "header": {
        "target": "main.user.CreateLimitedTokenForService",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {
            "service_secret": "some text",
            "service_token": "some text",
            "api_list": [
                "string1",
                "string2",
                "string3"
            ]
        }
    }
}

main.user.CreateServiceToken

Create a token that can be used by an external service to create a limited access token for that user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • service_name - string - Name of the service associated to that token

Output:

  • service_token - string

Example:

{
    "header": {
        "target": "main.user.CreateServiceToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "service_name": "mylabel1"
        }
    }
}

main.user.DeleteServiceToken

Delete a user service token

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

Body Data:

  • service_secret - string - secret used to identify the calling service
  • service_token - string - user service token to be deleted

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.user.DeleteServiceToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {}
    },
    "body": {
        "data": {
            "service_secret": "some text",
            "service_token": "some text"
        }
    }
}

main.user.EditAvatar

Update the avatar of a user

Push information:

Pushing to: User list
With target: main.user.EditAvatar
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

User restriction: API user cannot access targeted users of this route if its rank is bellow theirs.
Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int

Body Data:

  • name - string Optional: ""
  • size - int Optional: 0
  • remove_avatar - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "main.user.EditAvatar",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345,
            "remove_avatar": true
        }
    }
}

main.user.GetCaldavSyncSettings

Get Caldav synchronization settings

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • projects_sync - LIST of struct
    • project_id - int
    • sync_enabled - bool

Example:

{
    "header": {
        "target": "main.user.GetCaldavSyncSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetGlobalStatus

Get global status of a user.

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • status - string
  • user_id - int

Example:

{
    "header": {
        "target": "main.user.GetGlobalStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetKnownUsersId

Return the id list of all the users knows
This list depends on the acting user role and the account options

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • known_user_id_list - LIST of int

Example:

{
    "header": {
        "target": "main.user.GetKnownUsersId",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetNotificationSettings

get user notification settings (enabled/disabled)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • channel - int - can be missing
  • documents - int - can be missing
  • tasks - int - can be missing
  • calendar - int - can be missing
  • meetings - int - can be missing

Example:

{
    "header": {
        "target": "main.user.GetNotificationSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetRelativeUsersId

Return the id list of all the users that have at least one project in common with the acting user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • relative_user_id_list - LIST of int

Example:

{
    "header": {
        "target": "main.user.GetRelativeUsersId",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetSelf

Get self user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.user.GetSelf",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.GetUserServicesInfo

Get third party services info for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.user.GetUserServicesInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.LinkTag

Link a tag to a user

Push information:

Pushing to: Unkown push action
With target: main.user.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int
  • tag_id - int

Output:

  • success - bool
  • user_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.ListProperties

Get all the user properties

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

Example:

{
    "header": {
        "target": "main.user.ListProperties",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.RemoveProperty

Remove a property for the user
The property will be used to its default value for this user

Push information:

Pushing to: Self
With target: main.user.RemoveProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_project_id - int Optional: null

Body Data:

  • property_type_id - PropertyType

Output:

Example:

{
    "header": {
        "target": "main.user.RemoveProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "property_type_id": "no example yet"
        }
    }
}

main.user.RemoveTag

Remove a tag in a user

Push information:

Pushing to: Unkown push action
With target: main.user.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int
  • tag_id - int

Output:

  • success - bool
  • user_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

main.user.RemoveTagByLabel

Remove a tag in a user using the label

Push information:

Pushing to: Unkown push action
With target: main.user.RemoveTagByLabel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_user_id - int
  • label - string

Output:

  • success - bool
  • user_id - int
  • tag - Tag

Example:

{
    "header": {
        "target": "main.user.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

main.user.RevokeService

Revoke a third party service for a user

Push information:

Pushing to: Self
With target: main.user.RevokeService
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • service - string

Output:

  • success - bool
  • service - string

Example:

{
    "header": {
        "target": "main.user.RevokeService",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "service": "some text"
        }
    }
}

main.user.SetNotificationSettings

set user notification settings (enabled/disabled)

Push information:

Pushing to: Self
With target: main.user.SetNotificationSettings
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • channel - int Optional: 0
  • documents - int Optional: 0
  • tasks - int Optional: 0
  • calendar - int Optional: 0
  • meetings - int Optional: 0

Output:

  • channel - int - can be missing
  • documents - int - can be missing
  • tasks - int - can be missing
  • calendar - int - can be missing
  • meetings - int - can be missing

Example:

{
    "header": {
        "target": "main.user.SetNotificationSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "channel": 12345,
            "documents": 12345,
            "tasks": 12345,
            "calendar": 12345,
            "meetings": 12345
        }
    }
}

main.user.SetProjectCaldavSync

Set Caldav synchronization for a project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • enabled - bool

Output:

  • project_sync - struct
    • project_id - int
    • sync_enabled - bool

Example:

{
    "header": {
        "target": "main.user.SetProjectCaldavSync",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "enabled": true
        }
    }
}

main.user.SetStatus

Set the status of the user. Status is linked to the session_id.

Push information:

Pushing to: Fellow users
With custom target: main.user.status
Stream value: Pushing on user stream (1) and on chat stream (2)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • status - string

Output:

  • status - string
  • user_id - int

Example:

{
    "header": {
        "target": "main.user.SetStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "status": "no example yet"
        }
    }
}

main.user.SetUserLanguage

Set a user language

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • locale - string

Output:

  • success - bool

Example:

{
    "header": {
        "target": "main.user.SetUserLanguage",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "locale": "some text"
        }
    }
}

main.user.SetUserStatus

Set the status of the user.

Push information:

Pushing to: Self
With target: main.user.SetUserStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • status - string

Output:

  • status - string
  • user_id - int

Example:

{
    "header": {
        "target": "main.user.SetUserStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "status": "no example yet"
        }
    }
}

main.user.Update

Update the user information

Push information:

Pushing to: User list
With target: main.user.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • phones - PhoneList Optional: []
  • first_name - string Optional: ""
  • last_name - string Optional: ""
  • login - string Optional: null
  • password - string Optional: null
  • old_password - string Optional: ""
  • gender - string Optional: "M."
  • skype - string Optional: ""
  • company - string Optional: ""
  • department - string Optional: null
  • title - string Optional: ""
  • saml_id - string Optional: ""
  • token_ttl_mins - int Optional: 0
  • custom_image_url - string Optional: ""
  • timezone - string Optional: ""
  • date_format_family - string Optional: ""
  • security_autologin - bool Optional: false
  • double_auth - bool Optional: false
  • name - string Optional: ""
  • size - int Optional: 0
  • remove_avatar - bool Optional: false

Output:

  • user - User
  • should_relog - bool - can be null
  • date_format_family - string
  • security_autologin - bool

Example:

{
    "header": {
        "target": "main.user.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "phones": "no example yet",
            "first_name": "some text",
            "last_name": "some text",
            "login": "my.email@domain.com",
            "password": "mypassword",
            "old_password": "some text",
            "gender": "some text",
            "skype": "some text",
            "company": "some text",
            "department": "label",
            "title": "some text",
            "saml_id": "some text",
            "token_ttl_mins": 12345,
            "custom_image_url": "some text",
            "timezone": "some text",
            "date_format_family": "some text",
            "security_autologin": true,
            "double_auth": true,
            "name": "some text",
            "size": 12345,
            "remove_avatar": true
        }
    }
}

main.user.UpdateProperty

Push information:

Pushing to: Self
With target: main.user.UpdateProperty
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • user_property - array

Output:

Example:

{
    "header": {
        "target": "main.user.UpdateProperty",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "user_property": {
                "property_type_id": 12345,
                "property_value": "my value",
                "project_id": 12345
            }
        }
    }
}

main.util.GetSpecificTrad

Get specific trad in specific lang

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • lang - string
  • trad_key - string

Output:

  • success - bool
  • trad - string

Example:

{
    "header": {
        "target": "main.util.GetSpecificTrad",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "lang": "some text",
            "trad_key": "some text"
        }
    }
}

meeting.meeting.Add

Add a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.Add
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • user_id_list - int list Optional: []
  • ext_user_list - list Optional: []
  • name - string
  • place - string
  • description - string Optional: ""
  • dates - list
  • notify_availability - bool Optional: true
  • notify_creation - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.Add",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id_list": [
                12345,
                12346
            ],
            "ext_user_list": [
                {
                    "email": "external_user1@domain.com",
                    "first_name": "first_name1",
                    "last_name": "last_name1"
                },
                {
                    "email": "external_user2@domain.com",
                    "first_name": "first_name2",
                    "last_name": "last_name2"
                }
            ],
            "name": "some text",
            "place": "some text",
            "description": "some text",
            "dates": {
                "datetime_start": "2016-11-27 17:10:05",
                "datetime_end": "2016-12-23 17:10:05"
            },
            "notify_availability": true,
            "notify_creation": true
        }
    }
}

meeting.meeting.AddDates

Add dates to a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.AddDates
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Body Data:

  • dates - list

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.AddDates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {
            "dates": {
                "datetime_start": "2016-11-27 17:10:05",
                "datetime_end": "2016-12-23 17:10:05"
            }
        }
    }
}

meeting.meeting.AddExternalParticipants

Add external participants to a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.AddExternalParticipants
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Body Data:

  • ext_user_list - list

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.AddExternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {
            "ext_user_list": [
                {
                    "email": "external_user1@domain.com",
                    "first_name": "first_name1",
                    "last_name": "last_name1"
                },
                {
                    "email": "external_user2@domain.com",
                    "first_name": "first_name2",
                    "last_name": "last_name2"
                }
            ]
        }
    }
}

meeting.meeting.AddInternalParticipants

Add internal participants to a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.AddInternalParticipants
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Body Data:

  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.AddInternalParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id_list": [
                12345,
                12346
            ]
        }
    }
}

meeting.meeting.Delete

Delete a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Output:

  • success - bool
  • meeting_id - int

Example:

{
    "header": {
        "target": "meeting.meeting.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

meeting.meeting.Edit

Edit a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.Edit
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Body Data:

  • name - string Optional: ""
  • place - string Optional: ""
  • description - string Optional: ""
  • notify_availability - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.Edit",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "place": "some text",
            "description": "some text",
            "notify_availability": true
        }
    }
}

meeting.meeting.FixDate

Fix a date

Push information:

Pushing to: User list
With target: meeting.meeting.FixDate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int
  • date_id - int

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.FixDate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345,
            "date_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

meeting.meeting.Get

Get a meeting

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

meeting.meeting.GetList

Get meetings

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool
  • meetings - LIST of Meeting

Example:

{
    "header": {
        "target": "meeting.meeting.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

meeting.meeting.RemoveParticipants

Remove participants from a meeting
Impact both internal and external participants

Push information:

Pushing to: User list
With target: meeting.meeting.RemoveParticipants
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Body Data:

  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.RemoveParticipants",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {
            "user_id_list": [
                12345,
                12346
            ]
        }
    }
}

meeting.meeting.UnfixDate

Unfix a date

Push information:

Pushing to: User list
With target: meeting.meeting.UnfixDate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.UnfixDate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

meeting.meeting.UpdateStatus

Add external users to a meeting

Push information:

Pushing to: User list
With target: meeting.meeting.UpdateStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Meetings restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • meeting_id - int
  • date_id - int

Body Data:

  • status - int

Output:

Example:

{
    "header": {
        "target": "meeting.meeting.UpdateStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "meeting_id": 12345,
            "date_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

poll.poll.Vote

Vote for a poll

Push information:

Pushing to: Self
With target: poll.poll.Vote
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • poll_id - int

Body Data:

  • answers - list

Output:

  • success - bool
  • poll - Poll

Example:

{
    "header": {
        "target": "poll.poll.Vote",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "poll_id": 12345
        }
    },
    "body": {
        "data": {
            "answers": "no example yet"
        }
    }
}

reporting.task.Burndown

Get burndown

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []
  • period - string Optional: "week"
  • unit - string Optional: "hours"

Output:

  • success - bool
  • burndown - object

Example:

{
    "header": {
        "target": "reporting.task.Burndown",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ],
            "period": "some text",
            "unit": "some text"
        }
    }
}

reporting.task.Load

Load all stats

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []
  • period - string Optional: "week"

Output:

  • success - bool
  • workload - Workload
  • status - object
  • burndown - object
  • performance - object
  • tags - LIST of TagReporting

Example:

{
    "header": {
        "target": "reporting.task.Load",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ],
            "period": "some text"
        }
    }
}

reporting.task.Performance

Get performance

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []
  • period - string Optional: "week"
  • unit - string Optional: "hours"
  • by_user - bool Optional: false

Output:

  • success - bool
  • performance - object

Example:

{
    "header": {
        "target": "reporting.task.Performance",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ],
            "period": "some text",
            "unit": "some text",
            "by_user": true
        }
    }
}

reporting.task.Status

Get status

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []

Output:

  • success - bool
  • status - object

Example:

{
    "header": {
        "target": "reporting.task.Status",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ]
        }
    }
}

reporting.task.Tags

Get tags

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []
  • tag_list - int list Optional: []
  • amount - int Optional: 0
  • order - int Optional: 1

Output:

Example:

{
    "header": {
        "target": "reporting.task.Tags",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ],
            "tag_list": [
                12345,
                12346
            ],
            "amount": 12345,
            "order": 12345
        }
    }
}

reporting.task.Workload

Get workload

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Reporting restrictions:
Access to module (1)
X


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • tasks_lists - int list Optional: []

Output:

Example:

{
    "header": {
        "target": "reporting.task.Workload",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "tasks_lists": [
                12345,
                12346
            ]
        }
    }
}

sharing.sharing.Download

Download a file from a sharing folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • file_id - int
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • success - bool
  • url - string

Example:

{
    "header": {
        "target": "sharing.sharing.Download",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.DownloadFile

Download a file from a sharing file

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • file_id - int
  • sharing_file_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "sharing.sharing.DownloadFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "file_id": 12345,
            "sharing_file_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.DownloadFileFromSharedFolder

Download a file from a shared folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • file_id - int
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "sharing.sharing.DownloadFileFromSharedFolder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "file_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.Folder

List entries of folder

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: 0
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • folder - Directory
  • tree - struct
    • files - LIST of File - can be null
    • links - LIST of Link - can be null
    • dirs - LIST of Directory - can be null

Example:

{
    "header": {
        "target": "sharing.sharing.Folder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.Load

Get information required to load sharing doc page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • sharing - Sharing
  • account - AccountBase
  • project - struct
    • name - string
  • folder - struct
    • name - string
  • user - struct
    • first_name - string - can be null
    • last_name - string - can be null
    • name - string - can be null
  • allow_upload - bool
  • allow_sub_folders - bool

Example:

{
    "header": {
        "target": "sharing.sharing.Load",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.LoadFile

Get information required to load file sharing page

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • sharing_file_code - string

Body Data:

  • sharing_pwd - string Optional: ""

Output:

  • sharing - Sharing
  • account - AccountBase
  • file - File
  • user - struct
    • first_name - string - can be null
    • last_name - string - can be null
    • name - string - can be null

Example:

{
    "header": {
        "target": "sharing.sharing.LoadFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "sharing_file_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.RequestLinkPreview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • link_id - Link
  • sharing_code - string Optional: null

Body Data:

  • sharing_pwd - string Optional: ""

Output:

Documentation not available yet

Example:

{
    "header": {
        "target": "sharing.sharing.RequestLinkPreview",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text"
        }
    }
}

sharing.sharing.Upload

Upload a file via a sharing folder

Push information:

Pushing to: Project users
With target: sharing.sharing.Upload
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • dir_id - int Optional: null
  • sharing_code - string

Body Data:

  • sharing_pwd - string Optional: ""
  • notify - bool Optional: false
  • timestamp - string Optional: ""
  • replace_master - bool Optional: false
  • name - string
  • size - int

Output:

  • file - File
  • id_version_of - int - can be missing - can be null

Example:

{
    "header": {
        "target": "sharing.sharing.Upload",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "sharing_code": "sharingcodexyz"
        }
    },
    "body": {
        "data": {
            "sharing_pwd": "some text",
            "notify": true,
            "timestamp": "some text",
            "replace_master": true,
            "name": "some text",
            "size": 12345
        }
    }
}

social.community.Archive

Archive a community

Push information:

Pushing to: User list
With target: social.community.Archive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • user_id - int
  • date - datetime

Example:

{
    "header": {
        "target": "social.community.Archive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.Create

Create a community

Push information:

Pushing to: User list
With target: social.community.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • description - string Optional: ""
  • subscription_type - int
  • allow_unsubscription - bool Optional: true
  • allow_guests - bool Optional: false
  • post_creation_auth - int Optional: 0
  • view_members_auth - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "social.community.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "description": "some text",
            "subscription_type": 12345,
            "allow_unsubscription": true,
            "allow_guests": true,
            "post_creation_auth": 12345,
            "view_members_auth": 12345
        }
    }
}

social.community.Delete

Delete a community

Push information:

Pushing to: User list
With target: social.community.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • trash_user_id - int
  • trash_date - datetime

Example:

{
    "header": {
        "target": "social.community.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.GetArchivedList

Get the list of archived community for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • communities - LIST of Community

Example:

{
    "header": {
        "target": "social.community.GetArchivedList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.GetAuthList

Get a list of community member auth

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • auth_list - LIST of MemberAuth

Example:

{
    "header": {
        "target": "social.community.GetAuthList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.GetDiscoveryList

Get the list of community for a user to discover

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • communities - LIST of Community

Example:

{
    "header": {
        "target": "social.community.GetDiscoveryList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.GetFavoritePostList

Get the list of favorite post

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • with_polls - bool Optional: false

Output:

  • success - bool
  • posts - LIST of CommunityPost
  • poll_list - LIST of Poll - can be missing

Example:

{
    "header": {
        "target": "social.community.GetFavoritePostList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "with_polls": true
        }
    }
}

social.community.GetList

Get the list of community for a user

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • communities - LIST of Community

Example:

{
    "header": {
        "target": "social.community.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.GetPinnedPostList

Get a list of pinned post for a community

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • with_polls - bool Optional: false

Output:

  • success - bool
  • posts - LIST of CommunityPost
  • poll_list - LIST of Poll - can be missing

Example:

{
    "header": {
        "target": "social.community.GetPinnedPostList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "with_polls": true
        }
    }
}

social.community.GetPostList

Get a list of post

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_post_id_list - int list

Body Data:

  • with_polls - bool Optional: false

Output:

  • success - bool
  • posts - LIST of CommunityPost
  • poll_list - LIST of Poll - can be missing

Example:

{
    "header": {
        "target": "social.community.GetPostList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id_list": [
                1,
                2,
                3
            ]
        }
    },
    "body": {
        "data": {
            "with_polls": true
        }
    }
}

social.community.GetRecentPostList

Get a list of recent post for a community list
Takes a list community id. If empty, posts from all communities are returned (feed).

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • include_pinned - bool Optional: false
  • limit - int Optional: 10
  • excluded_post_id_list - int list Optional: []
  • with_polls - bool Optional: false

Output:

  • success - bool
  • posts - LIST of CommunityPost
  • limit - int
  • poll_list - LIST of Poll - can be missing

Example:

{
    "header": {
        "target": "social.community.GetRecentPostList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "include_pinned": true,
            "limit": 12345,
            "excluded_post_id_list": [
                12345,
                12346
            ],
            "with_polls": true
        }
    }
}

social.community.GetUnseenActivity

Get a list of unseen activity

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • activity_list - LIST of struct
    • community_id - int
    • community_post_id - int
    • is_new - bool
    • last_unseen_comment_id - int - can be null

Example:

{
    "header": {
        "target": "social.community.GetUnseenActivity",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.PublishPost

Publish into a community

Push information:

Pushing to: User list
With target: social.community.PublishPost
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • content - string
  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null
  • poll - struct Optional: stdClass Object ( )
  • content_type - int Optional: 1
  • allow_comments - bool Optional: true
  • is_pinned - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "social.community.PublishPost",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "content": "mylabel1",
            "integration_attachment": "no example yet",
            "poll": "no example yet",
            "content_type": 12345,
            "allow_comments": true,
            "is_pinned": true
        }
    }
}

social.community.RemoveMember

Remove a member from the community

Push information:

Pushing to: User list
With target: social.community.RemoveMember
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • success - bool
  • community_id - int
  • member_id - int
  • member_type_id - int
  • user_role_list - LIST of struct
    • user_id - int
    • role - int
  • auth_list - LIST of MemberAuth

Example:

{
    "header": {
        "target": "social.community.RemoveMember",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

social.community.ResubscribeMember

Force subscription of a member from the community

Push information:

Pushing to: User list
With target: social.community.ResubscribeMember
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • member - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Output:

  • success - bool
  • community_id - int
  • user_id - int
  • role - int

Example:

{
    "header": {
        "target": "social.community.ResubscribeMember",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    },
    "body": {
        "data": {}
    }
}

social.community.Subscribe

Subscribe to a community

Push information:

Pushing to: User list
With target: social.community.Subscribe
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • user_id - int
  • role - int

Example:

{
    "header": {
        "target": "social.community.Subscribe",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.ToggleFavorite

Toggle favorite for a community

Push information:

Pushing to: Self
With target: social.community.ToggleFavorite
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • favorite - bool

Output:

  • success - bool
  • community_id - int
  • favorite - bool

Example:

{
    "header": {
        "target": "social.community.ToggleFavorite",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "favorite": true
        }
    }
}

social.community.Unarchive

Unarchive a community

Push information:

Pushing to: User list
With target: social.community.Unarchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int

Example:

{
    "header": {
        "target": "social.community.Unarchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.Unsubscribe

Unsubscribe from a community

Push information:

Pushing to: User list
With target: social.community.Unsubscribe
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "social.community.Unsubscribe",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.community.Update

Update a community

Push information:

Pushing to: User list
With target: social.community.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • name - string Optional: null
  • description - string Optional: ""
  • subscription_type - int Optional: 0
  • allow_unsubscription - bool Optional: true
  • allow_guests - bool Optional: false
  • post_creation_auth - int Optional: 0
  • view_members_auth - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "social.community.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "description": "some text",
            "subscription_type": 12345,
            "allow_unsubscription": true,
            "allow_guests": true,
            "post_creation_auth": 12345,
            "view_members_auth": 12345
        }
    }
}

social.community.UpdateAuthList

Update (add or create) the list of auth for a community

Push information:

Pushing to: User list
With target: social.community.UpdateAuthList
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • member_list - array
    • - member_id: id of the member
    • - member_type_id: type id of the member: 1 for user, 2 for user group

Body Data:

  • auth - int

Output:

  • success - bool
  • community_id - int
  • auth - int
  • member_list - LIST of struct
    • member_id - int
    • member_type_id - int
  • auth_list - LIST of MemberAuth
  • user_role_list - LIST of struct
    • user_id - int
    • role - int

Example:

{
    "header": {
        "target": "social.community.UpdateAuthList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "member_list": [
                {
                    "member_type_id": 1,
                    "member_id": 12345
                },
                {
                    "member_type_id": 2,
                    "member_id": 12345
                }
            ]
        }
    },
    "body": {
        "data": {
            "auth": 12345
        }
    }
}

social.community.UpdateAvatar

Update a community avatar

Push information:

Pushing to: User list
With target: social.community.UpdateAvatar
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • name - string Optional: ""
  • info - string Optional: ""
  • size - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • avatar_id - int - can be null

Example:

{
    "header": {
        "target": "social.community.UpdateAvatar",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "info": "some text",
            "size": 12345
        }
    }
}

social.community.UpdateBackground

Update a community background cover

Push information:

Pushing to: User list
With target: social.community.UpdateBackground
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0

Body Data:

  • name - string Optional: ""
  • info - string Optional: ""
  • size - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • background_id - int - can be null

Example:

{
    "header": {
        "target": "social.community.UpdateBackground",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "info": "some text",
            "size": 12345
        }
    }
}

social.community.UpdatePost

Update a post

Push information:

Pushing to: User list
With target: social.community.UpdatePost
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • content - string
  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null
  • content_type - int Optional: 1

Output:

Example:

{
    "header": {
        "target": "social.community.UpdatePost",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "content": "mylabel1",
            "integration_attachment": "no example yet",
            "content_type": 12345
        }
    }
}

social.post.AddExternalAttachment

Attach an external file to a post

Push information:

Pushing to: User list
With target: social.post.AddExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • name - string
  • size - int
  • file_timestamp - string Optional: ""

Output:

  • success - bool
  • attachment - ExternalAttachment
  • community_post_id - int
  • community_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "social.post.AddExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345,
            "file_timestamp": "some text"
        }
    }
}

social.post.ClearUnseen

Flag posts as seen

Push information:

Pushing to: User list
With target: social.post.ClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • last_seen_comment_id - int Optional: 0

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • last_seen_comment_id - int - can be null
  • user_id - int

Example:

{
    "header": {
        "target": "social.post.ClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "last_seen_comment_id": 12345
        }
    }
}

social.post.DeleteComment

Delete a comment on a post

Push information:

Pushing to: User list
With target: social.post.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • community_post_comment_id - string

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • community_post_comment_id - int

Example:

{
    "header": {
        "target": "social.post.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "community_post_comment_id": "abc"
        }
    },
    "body": {
        "data": {}
    }
}

social.post.DeletePost

Delete a post

Push information:

Pushing to: User list
With target: social.post.DeletePost
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Output:

  • success - bool
  • community_id - int
  • community_post_id - int

Example:

{
    "header": {
        "target": "social.post.DeletePost",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.post.DownloadAttachment

Download a post attachment

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • attachment_id - int

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "social.post.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.post.EditComment

Edit a comment on a post

Push information:

Pushing to: User list
With target: social.post.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • community_post_comment_id - string

Body Data:

  • message - string

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "social.post.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "community_post_comment_id": "abc"
        }
    },
    "body": {
        "data": {
            "message": "some text"
        }
    }
}

social.post.GetPostReaders

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Output:

  • success - bool
  • readers_id_list - LIST of int

Example:

{
    "header": {
        "target": "social.post.GetPostReaders",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.post.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • attachment_id - int

Body Data:

  • preview_type - string Optional: "default"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • output_type - string
  • doc_type - string
  • doc_id - int

Example:

{
    "header": {
        "target": "social.post.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

social.post.PublishComment

Publish a comment on a post

Push information:

Pushing to: User list
With target: social.post.PublishComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • message - string
  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • comment - Comment

Example:

{
    "header": {
        "target": "social.post.PublishComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "message": "some text",
            "integration_attachment": "no example yet"
        }
    }
}

social.post.RemoveExternalAttachment

Remove an external attachment from a community post

Push information:

Pushing to: User list
With target: social.post.RemoveExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • attachment_id - int

Output:

  • success - bool
  • attachment_id - int
  • community_id - int
  • community_post_id - int

Example:

{
    "header": {
        "target": "social.post.RemoveExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

social.post.SetCommentIntegrationAttachment

Set the integration attachment for a post comment

Push information:

Pushing to: User list
With target: social.post.SetCommentIntegrationAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int
  • community_post_comment_id - string

Body Data:

  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • community_post_comment_id - int
  • integration_attachment - IntegrationAttachment - can be null

Example:

{
    "header": {
        "target": "social.post.SetCommentIntegrationAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345,
            "community_post_comment_id": "abc"
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet"
        }
    }
}

social.post.SetIntegrationAttachment

Set the integration attachment for a post

Push information:

Pushing to: User list
With target: social.post.SetIntegrationAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • api_key - string Optional: ""
  • community_post_id - int

Body Data:

  • integration_attachment - Wimi\WApi\Parameter\WapiParamIntegrationAttachment Optional: null

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • integration_attachment - IntegrationAttachment - can be null

Example:

{
    "header": {
        "target": "social.post.SetIntegrationAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "integration_attachment": "no example yet"
        }
    }
}

social.post.ToggleCommentReaction

Toggle a reaction to a comment

Push information:

Pushing to: User list
With target: social.post.ToggleCommentReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_comment_id - string

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • community_post_comment_id - int
  • user_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "social.post.ToggleCommentReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_comment_id": "abc"
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

social.post.ToggleCommentsEnabled

Toggle comments enabled for a community post

Push information:

Pushing to: User list
With target: social.post.ToggleCommentsEnabled
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • comments_enabled - bool

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • comments_enabled - bool
  • comments - LIST of Comment

Example:

{
    "header": {
        "target": "social.post.ToggleCommentsEnabled",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "comments_enabled": true
        }
    }
}

social.post.ToggleFavorite

Toggle favorite for a community post

Push information:

Pushing to: Self
With target: social.post.ToggleFavorite
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • favorite - bool

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • favorite - bool

Example:

{
    "header": {
        "target": "social.post.ToggleFavorite",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "favorite": true
        }
    }
}

social.post.TogglePinned

Toggle pinned for a community post

Push information:

Pushing to: User list
With target: social.post.TogglePinned
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • pinned - bool

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • pinned - bool

Example:

{
    "header": {
        "target": "social.post.TogglePinned",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "pinned": true
        }
    }
}

social.post.ToggleReaction

Toggle a reaction to a post

Push information:

Pushing to: User list
With target: social.post.ToggleReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • community_id - int Optional: 0
  • community_post_id - int

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • community_id - int
  • community_post_id - int
  • user_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "social.post.ToggleReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "community_post_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

task.filter.Add

Adds a filter on tasks to the project or on unified tasks

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • name - string
  • title - string Optional: ""
  • lists - int list Optional: []
  • tags - string list Optional: []
  • tags_logic - string Optional: ""
  • owners - int list Optional: []
  • statuses - int list Optional: []
  • late - bool Optional: false
  • last_occurrences - bool Optional: false
  • after_list_end_date - bool Optional: false
  • order_by_group - bool Optional: false
  • personalized_entries_filters - PersonalizedEntryValues Optional: []
  • date_option - string Optional: null
  • dates_delay - array Optional: null

Output:

  • success - bool
  • filter - Filter

Example:

{
    "header": {
        "target": "task.filter.Add",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "title": "some text",
            "lists": [
                12345,
                12346
            ],
            "tags": [
                "string1",
                "string2",
                "string3"
            ],
            "tags_logic": "some text",
            "owners": [
                12345,
                12346
            ],
            "statuses": [
                12345,
                12346
            ],
            "late": true,
            "last_occurrences": true,
            "after_list_end_date": true,
            "order_by_group": true,
            "personalized_entries_filters": [
                12345,
                12346
            ],
            "date_option": "date_PEnd",
            "dates_delay": [
                "2021-01-01 00:00:00",
                "2021-02-01 00:00:00"
            ]
        }
    }
}

task.filter.Apply

Apply a filter on the tasks of the given projects

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • target_project_id - int Optional: null

Body Data:

  • title - string Optional: ""
  • lists - int list Optional: []
  • tags - string list Optional: []
  • tags_logic - string Optional: ""
  • owners - int list Optional: []
  • statuses - int list Optional: []
  • late - bool Optional: false
  • last_occurrences - bool Optional: false
  • after_list_end_date - bool Optional: false
  • order_by_group - bool Optional: false
  • personalized_entries_filters - PersonalizedEntryValues Optional: []
  • date_option - string Optional: null
  • dates_delay - array Optional: null
  • task_order_by - string Optional: "deadline"
  • task_order - string Optional: "ASC"
  • workspace_order_by - string Optional: "name"
  • workspace_order - string Optional: "ASC"
  • page - int Optional: 1

Output:

  • success - bool
  • tasks - LIST of Task - can be null
  • order_by_group - bool
  • pagination - Pagination

Example:

{
    "header": {
        "target": "task.filter.Apply",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "title": "some text",
            "lists": [
                12345,
                12346
            ],
            "tags": [
                "string1",
                "string2",
                "string3"
            ],
            "tags_logic": "some text",
            "owners": [
                12345,
                12346
            ],
            "statuses": [
                12345,
                12346
            ],
            "late": true,
            "last_occurrences": true,
            "after_list_end_date": true,
            "order_by_group": true,
            "personalized_entries_filters": [
                12345,
                12346
            ],
            "date_option": "date_PEnd",
            "dates_delay": [
                "2021-01-01 00:00:00",
                "2021-02-01 00:00:00"
            ],
            "task_order_by": "deadline",
            "task_order": "ASC",
            "workspace_order_by": "name",
            "workspace_order": "ASC",
            "page": 12345
        }
    }
}

task.filter.Delete

Delete a filter

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • filter_id - int

Output:

  • success - bool
  • filter_id - int

Example:

{
    "header": {
        "target": "task.filter.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "filter_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.filter.Edit

Edits a filter on tasks

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int
  • filter_id - int

Body Data:

  • name - string Optional: null
  • title - string Optional: ""
  • lists - int list Optional: []
  • tags - string list Optional: []
  • tags_logic - string Optional: null
  • owners - int list Optional: []
  • statuses - int list Optional: []
  • late - bool Optional: false
  • last_occurrences - bool Optional: false
  • after_list_end_date - bool Optional: false
  • order_by_group - bool Optional: false
  • personalized_entries_filters - PersonalizedEntryValues Optional: []
  • date_option - string Optional: null
  • dates_delay - array Optional: null

Output:

  • success - bool
  • filter - Filter

Example:

{
    "header": {
        "target": "task.filter.Edit",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "filter_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "mylabel1",
            "title": "some text",
            "lists": [
                12345,
                12346
            ],
            "tags": [
                "string1",
                "string2",
                "string3"
            ],
            "tags_logic": "mylabel1",
            "owners": [
                12345,
                12346
            ],
            "statuses": [
                12345,
                12346
            ],
            "late": true,
            "last_occurrences": true,
            "after_list_end_date": true,
            "order_by_group": true,
            "personalized_entries_filters": [
                12345,
                12346
            ],
            "date_option": "date_PEnd",
            "dates_delay": [
                "2021-01-01 00:00:00",
                "2021-02-01 00:00:00"
            ]
        }
    }
}

task.filter.Get

Get a tasks filter

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • filter_id - int

Output:

  • success - bool
  • filter - Filter

Example:

{
    "header": {
        "target": "task.filter.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "filter_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.filter.List

List tasks filters

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool
  • filters - LIST of Filter - can be null

Example:

{
    "header": {
        "target": "task.filter.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.filter.ListUnified

List unified tasks filters

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Header Identification:

  • account_id - int
  • user_id - int

Output:

  • success - bool
  • filters - LIST of Filter - can be null

Example:

{
    "header": {
        "target": "task.filter.ListUnified",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.subtask.AddOwners

Add Owner to a subtask

Push information:

Pushing to: Task users
With target: task.subtask.AddOwners
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • subtask_id - int
  • task_id - int
  • user_id_list - int list

Output:

  • success - bool
  • task - Task
  • owners - LIST of int - can be null
  • subtask - Subtask

Example:

{
    "header": {
        "target": "task.subtask.AddOwners",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "subtask_id": 12345,
            "task_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.subtask.ChangeStatus

Change status of a subtask

Push information:

Pushing to: Task users
With target: task.subtask.ChangeStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • subtask_id - int

Body Data:

  • status - bool

Output:

  • success - bool
  • task - Task
  • subtask - Subtask
  • is_done - bool

Example:

{
    "header": {
        "target": "task.subtask.ChangeStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "subtask_id": 12345
        }
    },
    "body": {
        "data": {
            "status": true
        }
    }
}

task.subtask.Create

Create a subtask for the given task

Push information:

Pushing to: Task users
With target: task.subtask.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • label - string

Output:

Example:

{
    "header": {
        "target": "task.subtask.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1"
        }
    }
}

task.subtask.Delete

Delete a subtask

Push information:

Pushing to: Task users
With target: task.subtask.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • subtask_id - int

Output:

Example:

{
    "header": {
        "target": "task.subtask.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "subtask_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.subtask.Move

Move a subtask to another position (and/or task)

Push information:

Pushing to: Task users
With target: task.subtask.Move
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • subtask_id - int

Body Data:

  • position - int

Output:

Example:

{
    "header": {
        "target": "task.subtask.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "subtask_id": 12345
        }
    },
    "body": {
        "data": {
            "position": 12345
        }
    }
}

task.subtask.RemoveOwners

Add Owner to a subtask

Push information:

Pushing to: Task users
With target: task.subtask.RemoveOwners
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • subtask_id - int
  • task_id - int
  • user_id_list - int list

Output:

Example:

{
    "header": {
        "target": "task.subtask.RemoveOwners",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "subtask_id": 12345,
            "task_id": 12345,
            "user_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.subtask.Update

Update a subtask

Push information:

Pushing to: Task users
With target: task.subtask.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • subtask_id - int

Body Data:

  • label - string

Output:

Example:

{
    "header": {
        "target": "task.subtask.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "subtask_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1"
        }
    }
}

task.task.AddBatchOwner

Get all tasks of a list

Push information:

Pushing to: Tasks users
With target: task.task.AddBatchOwner
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • owner_list_id - int list

Output:

  • success - bool
  • tasks - LIST of Task

Example:

{
    "header": {
        "target": "task.task.AddBatchOwner",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "owner_list_id": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.task.AddComment

Add a comment to a task

Push information:

Pushing to: Task users
With target: task.task.AddComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "task.task.AddComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "mylabel1"
        }
    }
}

task.task.AddExternalAttachment

Attach an external file to a task

Push information:

Pushing to: Task users
With target: task.task.AddExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • file_timestamp - string Optional: ""
  • name - string
  • size - int

Output:

Example:

{
    "header": {
        "target": "task.task.AddExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "file_timestamp": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}

task.task.AddExternalAttachmentFromTemplate

Attach an external file to a task, from a template

Push information:

Pushing to: Task users
With target: task.task.AddExternalAttachmentFromTemplate
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • file_template_id - int

Body Data:

  • name - string Optional: ""

Output:

Example:

{
    "header": {
        "target": "task.task.AddExternalAttachmentFromTemplate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "file_template_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text"
        }
    }
}

task.task.AddReminder

Add a reminder for a task

Push information:

Pushing to: Task users
With target: task.task.AddReminder
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • reminder - Reminder

Output:

Example:

{
    "header": {
        "target": "task.task.AddReminder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "reminder": [
                {
                    "value": 1,
                    "unit": "w",
                    "date_label": 0
                },
                {
                    "value": 2,
                    "unit": "d",
                    "date_label": 1
                },
                {
                    "value": 3,
                    "unit": "h",
                    "date_label": 0
                },
                {
                    "value": 4,
                    "unit": "m",
                    "date_label": 1
                }
            ]
        }
    }
}

task.task.AddTag

Add a tag in a task

Push information:

Pushing to: Task users
With target: task.task.AddTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • label - string

Output:

  • success - bool
  • task - Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

task.task.AddWimiAttachment

Attach a wimi file to a task

Push information:

Pushing to: Task users
With target: task.task.AddWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • file_id - int

Output:

Example:

{
    "header": {
        "target": "task.task.AddWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.BatchDelete

Delete a batch of tasks

Push information:

Pushing to: User list
With target: task.task.BatchDelete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array

Output:

Example:

{
    "header": {
        "target": "task.task.BatchDelete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.task.BatchDuplicate

Copy a batch of tasks

Push information:

Pushing to: Tasks users
With target: task.task.BatchDuplicate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • target_project_id - int Optional: null
  • task_list_id - int Optional: null
  • task_id_list - int array

Output:

  • success - bool
  • task_list - LIST of Task
  • list - int - can be null

Example:

{
    "header": {
        "target": "task.task.BatchDuplicate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.task.BatchLinkTag

Link a tag to a list of tasks

Push information:

Pushing to: Tasks users
With target: task.task.BatchLinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • tag_id - int

Output:

  • success - bool
  • task_list - LIST of Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.BatchLinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.BatchMove

Move a batch of tasks to a position

Push information:

Pushing to: Tasks users
With target: task.task.BatchMove
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • task_list_id - int

Body Data:

  • position - int

Output:

  • success - bool
  • task_id_list - LIST of int
  • tasks - LIST of Task
  • newlist - int
  • newpos - int
  • changes - LIST of TaskPositionChange

Example:

{
    "header": {
        "target": "task.task.BatchMove",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "position": 12345
        }
    }
}

task.task.BatchMoveAfter

Move a batch of tasks after another

Push information:

Pushing to: Tasks users
With target: task.task.BatchMoveAfter
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • target_task_id - int
  • task_list_id - int

Output:

  • success - bool
  • task_id_list - LIST of int
  • newlist - int
  • previous_task_id - int
  • newpos - int
  • changes - LIST of TaskPositionChange

Example:

{
    "header": {
        "target": "task.task.BatchMoveAfter",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "target_task_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.BatchRemoveTag

Remove a tag in list of tasks

Push information:

Pushing to: Tasks users
With target: task.task.BatchRemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • tag_id - int

Output:

  • success - bool
  • task_list - LIST of Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.BatchRemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.ChangeStatus

Change the status of a given task

Push information:

Pushing to: Task users
With target: task.task.ChangeStatus
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • status - int

Output:

  • success - bool
  • task - Task
  • previous_status - int

Example:

{
    "header": {
        "target": "task.task.ChangeStatus",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

task.task.ChangeStatusBulk

Change the status of several tasks

Push information:

Pushing to: Tasks users
With target: task.task.ChangeStatusBulk
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array

Body Data:

  • status - int

Output:

  • success - bool
  • tasks - LIST of Task
  • status - int

Example:

{
    "header": {
        "target": "task.task.ChangeStatusBulk",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "status": 12345
        }
    }
}

task.task.ConversationArchive

Archive conversation

Push information:

Pushing to: Self
With target: task.task.ConversationArchive
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "task.task.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.ConversationClearUnseen

Clear unseen count for conversation

Push information:

Pushing to: Project users
With target: task.task.ConversationClearUnseen
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task_id - int
  • user_id - int

Example:

{
    "header": {
        "target": "task.task.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.ConversationSetSilent

Set silent for conversation

Push information:

Pushing to: Self
With target: task.task.ConversationSetSilent
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • silent - bool
  • silent_until - datetime Optional: null

Output:

  • success - bool
  • task_id - int
  • user_id - int
  • silent - bool
  • silent_until - datetime - can be missing - can be null

Example:

{
    "header": {
        "target": "task.task.ConversationSetSilent",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "silent": true,
            "silent_until": "2016-11-27 17:10:05"
        }
    }
}

task.task.Create

Create a task

Push information:

Pushing to: Task users
With target: task.task.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int
  • api_key - string Optional: ""

Body Data:

  • label - string
  • description - string Optional: ""
  • position - int Optional: 0
  • status - int Optional: 0
  • creation_date - datetime Optional: null
  • creation_user - int Optional: 0
  • begin_date - datetime Optional: null
  • due_date - datetime Optional: null
  • weight - float Optional: 0
  • weight_unit - string Optional: ""
  • owners - int list Optional: []
  • start_date - datetime Optional: null
  • start_user - int Optional: 0
  • completion_date - datetime Optional: null
  • completion_user - int Optional: 0
  • accepted_date - datetime Optional: null
  • accepted_user - int Optional: 0
  • update_date - datetime Optional: null
  • tags - list Optional: []
  • forceOwners - bool Optional: false

Output:

  • success - bool
  • task - Task

Example:

{
    "header": {
        "target": "task.task.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1",
            "description": "some text",
            "position": 12345,
            "status": 12345,
            "creation_date": "2016-11-27 17:10:05",
            "creation_user": 12345,
            "begin_date": "2016-11-27 17:10:05",
            "due_date": "2016-11-27 17:10:05",
            "weight": 12.345,
            "weight_unit": "some text",
            "owners": [
                12345,
                12346
            ],
            "start_date": "2016-11-27 17:10:05",
            "start_user": 12345,
            "completion_date": "2016-11-27 17:10:05",
            "completion_user": 12345,
            "accepted_date": "2016-11-27 17:10:05",
            "accepted_user": 12345,
            "update_date": "2016-11-27 17:10:05",
            "tags": "no example yet",
            "forceOwners": true
        }
    }
}

task.task.Delete

Delete a task

Push information:

Pushing to: User list
With target: task.task.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task - Task

Example:

{
    "header": {
        "target": "task.task.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.DeleteComment

Delete a task comment
Mark the message as deleted, does not delete it entirely

Push information:

Pushing to: Task users
With target: task.task.DeleteComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • comment_id - int (parameter needs to be owned by api user)

Output:

Example:

{
    "header": {
        "target": "task.task.DeleteComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.DeleteDates

Delete Dates from a Task
Delete all dates (due_date and begin_date) & task reminders

Push information:

Pushing to: Task users
With target: task.task.DeleteDates
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • date_label - string

Output:

  • success - bool
  • task - Task

Example:

{
    "header": {
        "target": "task.task.DeleteDates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "date_label": "some text"
        }
    }
}

task.task.DisableRecurrence

Disable a recurrence for a task

Push information:

Pushing to: Task users
With target: task.task.DisableRecurrence
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task - Task
  • recurrence_id - int

Example:

{
    "header": {
        "target": "task.task.DisableRecurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.DownloadAttachment

Attach a file to a task

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • attachment_id - int

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • file_path - string - can be missing
  • doc_type - string - can be missing
  • doc_id - int
  • output_type - string
  • item_type_id - int

Example:

{
    "header": {
        "target": "task.task.DownloadAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.Duplicate

Copy a task

Push information:

Pushing to: Task users
With target: task.task.Duplicate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • task_list_id - int

Output:

  • success - bool
  • task - Task
  • list - int

Example:

{
    "header": {
        "target": "task.task.Duplicate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.EditComment

Edit a comment of a task

Push information:

Pushing to: Task users
With target: task.task.EditComment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • comment - string

Output:

Example:

{
    "header": {
        "target": "task.task.EditComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "comment": "mylabel1"
        }
    }
}

task.task.Follow

Add self as follower to this task

Push information:

Pushing to: Self
With target: task.task.Follow
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task_id - int

Example:

{
    "header": {
        "target": "task.task.Follow",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.GenerateNextOccurrence

Generate the next occurrence of a task

Push information:

Pushing to: Task users
With target: task.task.GenerateNextOccurrence
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task - Task

Example:

{
    "header": {
        "target": "task.task.GenerateNextOccurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.GenerateWOGeneralFile

create an external file to a task

Push information:

Pushing to: Task users
With target: task.task.GenerateWOGeneralFile
Stream value: Pushing on all streams

Url:

https://api.files.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • name - string
  • file_format - string

Output:

Example:

{
    "header": {
        "target": "task.task.GenerateWOGeneralFile",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "file_format": "some text"
        }
    }
}

task.task.Get

Get a task with all its data

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

Example:

{
    "header": {
        "target": "task.task.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.GetAll

Get all tasks of a list

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Output:

  • tasks - LIST of Task

Example:

{
    "header": {
        "target": "task.task.GetAll",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.GetAttachmentList

Get the list of files attached to a task

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

Documentation not available yet

Example:

{
    "header": {
        "target": "task.task.GetAttachmentList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.GetNbNotCompletedForProject

Get the total amount of not completed tasks for the given project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • nb_tasks - int

Example:

{
    "header": {
        "target": "task.task.GetNbNotCompletedForProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.History

Get a task history

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

Example:

{
    "header": {
        "target": "task.task.History",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.LinkTag

Link a tag to a task

Push information:

Pushing to: Task users
With target: task.task.LinkTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • tag_id - int

Output:

  • success - bool
  • task - Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.LinkTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.Move

Move a task to new position

Push information:

Pushing to: Task users
With target: task.task.Move
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • task_list_id - int

Body Data:

  • position - int

Output:

  • success - bool
  • task - Task
  • newlist - int
  • newpos - int
  • oldlist - int
  • oldpos - int

Example:

{
    "header": {
        "target": "task.task.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "position": 12345
        }
    }
}

task.task.MoveAfter

Move a task after another

Push information:

Pushing to: Task users
With target: task.task.MoveAfter
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • target_task_id - int
  • task_list_id - int

Output:

  • success - bool
  • task - Task
  • newlist - int
  • oldlist - int
  • oldpos - int
  • previous_task_id - int

Example:

{
    "header": {
        "target": "task.task.MoveAfter",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "target_task_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.PreviewAttachment

Request attachment preview

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • attachment_id - int

Body Data:

  • preview_type - string Optional: "default"

Output:

  • md5 - string
  • date - string
  • name - string
  • size - int
  • preview_status - string
  • doc_type - string
  • type - string - can be missing
  • output_type - string
  • doc_id - int

Example:

{
    "header": {
        "target": "task.task.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {
            "preview_type": "some text"
        }
    }
}

task.task.Relocate

Relocate a task in an other project

Push information:

Pushing to: Tasks users
With target: task.task.Relocate
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • target_project_id - int Optional: null
  • task_id_list - int array
  • task_list_id - int

Output:

  • success - bool
  • task_id_list - LIST of int
  • task_list - LIST of Task
  • newlist - int
  • previous_project_id - int
  • project_id - int
  • changes - LIST of TaskPositionChange

Example:

{
    "header": {
        "target": "task.task.Relocate",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.RemoveBatchOwners

Get all tasks of a list

Push information:

Pushing to: Tasks users
With target: task.task.RemoveBatchOwners
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id_list - int array
  • owner_list_id - int list

Output:

  • success - bool
  • tasks - LIST of Task

Example:

{
    "header": {
        "target": "task.task.RemoveBatchOwners",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id_list": [
                12345,
                12346
            ],
            "owner_list_id": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.task.RemoveExternalAttachment

remove an external attachment from the task

Push information:

Pushing to: Task users
With target: task.task.RemoveExternalAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • attachment_id - int

Output:

  • success - bool
  • attachment_id - int
  • task - Task

Example:

{
    "header": {
        "target": "task.task.RemoveExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.RemoveReminder

Remove a reminder for a task

Push information:

Pushing to: Task users
With target: task.task.RemoveReminder
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • reminder - Reminder

Output:

Example:

{
    "header": {
        "target": "task.task.RemoveReminder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "reminder": [
                {
                    "value": 1,
                    "unit": "w",
                    "date_label": 0
                },
                {
                    "value": 2,
                    "unit": "d",
                    "date_label": 1
                },
                {
                    "value": 3,
                    "unit": "h",
                    "date_label": 0
                },
                {
                    "value": 4,
                    "unit": "m",
                    "date_label": 1
                }
            ]
        }
    }
}

task.task.RemoveTag

Remove a tag in a task

Push information:

Pushing to: Task users
With target: task.task.RemoveTag
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • tag_id - int

Output:

  • success - bool
  • task - Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.RemoveTagByLabel

Remove a tag in a task using the label

Push information:

Pushing to: Task users
With target: task.task.RemoveTagByLabel
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • label - string

Output:

  • success - bool
  • task - Task
  • tag - Tag

Example:

{
    "header": {
        "target": "task.task.RemoveTagByLabel",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}

task.task.RemoveWimiAttachment

Remove a wimi attachment from a task

Push information:

Pushing to: Task users
With target: task.task.RemoveWimiAttachment
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • attachment_id - int

Output:

  • success - bool
  • task - Task
  • attachment_id - int

Example:

{
    "header": {
        "target": "task.task.RemoveWimiAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "attachment_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.SendReminder

send a reminder to the owners of a task

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool

Example:

{
    "header": {
        "target": "task.task.SendReminder",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.SetRecurrence

Set or update a recurrence for the given task

Push information:

Pushing to: Task users
With target: task.task.SetRecurrence
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • start_date - date
  • creation_trigger_days - int Optional: 1
  • timezone - string
  • freq - string
  • count - int Optional: 0
  • until - date Optional: null
  • interval - int Optional: 1
  • byday - string list Optional: []
  • bymonthday - int list Optional: []
  • bymonth - int list Optional: []
  • bysetpos - int list Optional: []

Output:

  • success - bool
  • task - Task

Example:

{
    "header": {
        "target": "task.task.SetRecurrence",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27",
            "creation_trigger_days": 12345,
            "timezone": "some text",
            "freq": "some text",
            "count": 12345,
            "until": "2016-11-27",
            "interval": 12345,
            "byday": [
                "string1",
                "string2",
                "string3"
            ],
            "bymonthday": [
                12345,
                12346
            ],
            "bymonth": [
                12345,
                12346
            ],
            "bysetpos": [
                12345,
                12346
            ]
        }
    }
}

task.task.ToggleCommentReaction

Toggle a reaction to a comment

Push information:

Pushing to: Task users
With target: task.task.ToggleCommentReaction
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int
  • comment_id - int (parameter needs to be owned by api user)

Body Data:

  • reaction - string
  • active - bool

Output:

  • success - bool
  • task_id - int
  • comment_id - int
  • reaction - string
  • active - bool

Example:

{
    "header": {
        "target": "task.task.ToggleCommentReaction",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345,
            "comment_id": 12345
        }
    },
    "body": {
        "data": {
            "reaction": "some text",
            "active": true
        }
    }
}

task.task.ToggleDefaultOverdueAlert

Add or remove the default overdue alert for a task

Push information:

Pushing to: Task users
With target: task.task.ToggleDefaultOverdueAlert
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • enable - bool

Output:

Example:

{
    "header": {
        "target": "task.task.ToggleDefaultOverdueAlert",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "enable": true
        }
    }
}

task.task.Unfollow

Remove self as follower from this task

Push information:

Pushing to: Self
With target: task.task.Unfollow
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Output:

  • success - bool
  • task_id - int

Example:

{
    "header": {
        "target": "task.task.Unfollow",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.task.Update

Update a task

Push information:

Pushing to: User list
With target: task.task.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_id - int

Body Data:

  • label - string Optional: null
  • description - string Optional: ""
  • task_list_id - int Optional: null
  • status - int Optional: 0
  • begin_date - datetime Optional: null
  • due_date - datetime Optional: null
  • weight - float Optional: 0
  • weight_unit - string Optional: ""
  • reminders - string list Optional: []
  • owners - int list Optional: []
  • enable_default_overdue_alert - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "task.task.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1",
            "description": "some text",
            "task_list_id": 12345,
            "status": 12345,
            "begin_date": "2016-11-27 17:10:05",
            "due_date": "2016-11-27 17:10:05",
            "weight": 12.345,
            "weight_unit": "some text",
            "reminders": [
                "string1",
                "string2",
                "string3"
            ],
            "owners": [
                12345,
                12346
            ],
            "enable_default_overdue_alert": true
        }
    }
}

task.tlist.AddLink

Create a link between 2 lists given a specific relation type
Relation type can be start on end, start with, end with, etc DEPRECATED: see gantt.gantt.addLink

Push information:

Pushing to: Self
With target: task.tlist.AddLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • source_task_list_id - int
  • target_task_list_id - int

Body Data:

  • relation_type_id - int

Output:

Example:

{
    "header": {
        "target": "task.tlist.AddLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "source_task_list_id": 12345,
            "target_task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

task.tlist.BatchSetHidden

Set the tasks lists the user does not want to display
The given tasks lists will be returned with a flag 'invisible' to true when using the 'list' routes (dashboard, etc)

Push information:

Pushing to: Self
With target: task.tlist.BatchSetHidden
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id_list - int list

Output:

  • success - bool
  • task_list_id_list - LIST of int

Example:

{
    "header": {
        "target": "task.tlist.BatchSetHidden",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.ChangeLine

Change line in gantt view
Cannot be below 0

Push information:

Pushing to: Task list users
With target: task.tlist.ChangeLine
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • line - int

Output:

  • success - bool
  • list - TaskList
  • old_line - int - can be null
  • line_new - int - can be null

Example:

{
    "header": {
        "target": "task.tlist.ChangeLine",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "line": 12345
        }
    }
}

task.tlist.Copy

Push information:

Pushing to: Task list users
With target: task.tlist.Copy
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int
  • target_project_id - int Optional: null

Output:

Example:

{
    "header": {
        "target": "task.tlist.Copy",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.Create

Create a task list

Push information:

Pushing to: Task list users
With target: task.tlist.Create
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • label - string

Output:

Example:

{
    "header": {
        "target": "task.tlist.Create",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "mylabel1"
        }
    }
}

task.tlist.Dashboard

Get all necessary data for displaying the tasks module dashboard

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • getAccepted - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "task.tlist.Dashboard",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "getAccepted": true
        }
    }
}

task.tlist.DashboardGlobal

Get all necessary data for displaying the tasks module dashboard
Same as dashboard but for a user, not a project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int

Body Data:

  • without_tasks - bool Optional: true

Output:

Example:

{
    "header": {
        "target": "task.tlist.DashboardGlobal",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "without_tasks": true
        }
    }
}

task.tlist.Delete

Delete a task list

Push information:

Pushing to: User list
With target: task.tlist.Delete
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • delete_tasks - bool Optional: false

Output:

Example:

{
    "header": {
        "target": "task.tlist.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "delete_tasks": true
        }
    }
}

task.tlist.ExportAsCSV

Exports all tasks and lists of a project as csv

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id_list - int list

Body Data:

  • docs - bool Optional: false
  • delimiter - string Optional: ";"

Output:

  • success - bool

Example:

{
    "header": {
        "target": "task.tlist.ExportAsCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "docs": true,
            "delimiter": "some text"
        }
    }
}

task.tlist.ExportAsXLS

Exports all tasks and lists of a project as XLS

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id_list - int list

Body Data:

  • docs - bool Optional: false

Output:

  • success - bool

Example:

{
    "header": {
        "target": "task.tlist.ExportAsXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id_list": [
                12345,
                12346
            ]
        }
    },
    "body": {
        "data": {
            "docs": true
        }
    }
}

task.tlist.ExportFilteredAsXLS

Exports all tasks and lists as csv given filter options

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • target_project_id - int Optional: null

Body Data:

  • delimiter - string Optional: ";"
  • title - string Optional: ""
  • lists - int list Optional: []
  • tags - string list Optional: []
  • tags_logic - string Optional: ""
  • owners - int list Optional: []
  • statuses - int list Optional: []
  • late - bool Optional: false
  • last_occurrences - bool Optional: false
  • after_list_end_date - bool Optional: false
  • date_option - string Optional: null
  • dates_delay - array Optional: null

Output:

  • success - bool

Example:

{
    "header": {
        "target": "task.tlist.ExportFilteredAsXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "delimiter": "some text",
            "title": "some text",
            "lists": [
                12345,
                12346
            ],
            "tags": [
                "string1",
                "string2",
                "string3"
            ],
            "tags_logic": "some text",
            "owners": [
                12345,
                12346
            ],
            "statuses": [
                12345,
                12346
            ],
            "late": true,
            "last_occurrences": true,
            "after_list_end_date": true,
            "date_option": "date_PEnd",
            "dates_delay": [
                "2021-01-01 00:00:00",
                "2021-02-01 00:00:00"
            ]
        }
    }
}

task.tlist.Follow

Add self as follower to this list

Push information:

Pushing to: Self
With target: task.tlist.Follow
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Output:

  • success - bool
  • task_list_id - int

Example:

{
    "header": {
        "target": "task.tlist.Follow",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.GetAcceptedTasks

Get all Tasks that are accepted
Needs the list ID

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • list_id - int Optional: true
  • offset - int
  • limit - int

Output:

Example:

{
    "header": {
        "target": "task.tlist.GetAcceptedTasks",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "list_id": 12345,
            "offset": 12345,
            "limit": 12345
        }
    }
}

task.tlist.GetAll

Returns all tasks lists of a project

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

  • success - bool
  • lists - LIST of TaskList

Example:

{
    "header": {
        "target": "task.tlist.GetAll",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.GetList

Returns a task list with its stats

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Output:

Example:

{
    "header": {
        "target": "task.tlist.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.ImportFromCSV

Import tasks and lists from csv

Push information:

Pushing to: Main admins
With target: task.tlist.ImportFromCSV
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • name - string
  • size - int

Output:

  • success - bool
  • lists - LIST of TaskList
  • tasks - LIST of Task
  • errors - LIST of object

Example:

{
    "header": {
        "target": "task.tlist.ImportFromCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

task.tlist.ImportFromXLS

Import tasks and lists from xls

Push information:

Pushing to: Main admins
With target: task.tlist.ImportFromXLS
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the X-Wimi-WApi http header of the request.
It has to be encoded (encoding similar to the php function rawurlencode).
The file content is provided in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Body Data:

  • name - string
  • size - int

Output:

  • success - bool
  • lists - LIST of TaskList
  • tasks - LIST of Task
  • errors - LIST of object

Example:

{
    "header": {
        "target": "task.tlist.ImportFromXLS",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}

task.tlist.Move

Move a task list

Push information:

Pushing to: Task list users
With target: task.tlist.Move
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • position - int

Output:

  • success - bool
  • list - TaskList
  • oldpos - int
  • newpos - int

Example:

{
    "header": {
        "target": "task.tlist.Move",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "position": 12345
        }
    }
}

task.tlist.RemoveLink

Remove link between 2 lists
DEPRECATED: see gantt.gantt.addLink

Push information:

Pushing to: Self
With target: task.tlist.RemoveLink
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • source_task_list_id - int
  • target_task_list_id - int

Body Data:

  • relation_type_id - int

Output:

  • success - bool
  • task_list_link - TaskListLink - can be missing

Example:

{
    "header": {
        "target": "task.tlist.RemoveLink",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "source_task_list_id": 12345,
            "target_task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "relation_type_id": 12345
        }
    }
}

task.tlist.Unfollow

Remove self as follower from this list

Push information:

Pushing to: Self
With target: task.tlist.Unfollow
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Output:

  • success - bool
  • task_list_id - int

Example:

{
    "header": {
        "target": "task.tlist.Unfollow",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

task.tlist.Update

Update a task list

Push information:

Pushing to: Task list users
With target: task.tlist.Update
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • label - string Optional: ""
  • color - int Optional: 0

Output:

Example:

{
    "header": {
        "target": "task.tlist.Update",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "label": "some text",
            "color": 12345
        }
    }
}

task.tlist.UpdateDates

Push information:

Pushing to: Task list users
With target: task.tlist.UpdateDates
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • start_date - datetime Optional: null
  • end_date - datetime Optional: null

Output:

Example:

{
    "header": {
        "target": "task.tlist.UpdateDates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "start_date": "2016-11-27 17:10:05",
            "end_date": "2016-11-27 17:10:05"
        }
    }
}

task.tlist.UpdateExcludeAcceptedTask

Push information:

Pushing to: Task list users
With target: task.tlist.UpdateExcludeAcceptedTask
Stream value: Pushing on all streams

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int
  • task_list_id - int

Body Data:

  • exclude_accepted_task - int

Output:

Example:

{
    "header": {
        "target": "task.tlist.UpdateExcludeAcceptedTask",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "task_list_id": 12345
        }
    },
    "body": {
        "data": {
            "exclude_accepted_task": 12345
        }
    }
}

task.trash.List

List all trashed tasks lists and their tasks (also trashed)

Url:

https://api.wimi.pro

Call type:

The json message is sent in the http request body.

Restrictions:

This route is project restricted. This means you need to provide a project_id in the headers and have access to it.

Project restrictions:
Project members (0)Project administrators (5)
XX

Role restrictions:
Guests (-5)Contributors (0)Managers (1)Administrators (2)Account manager (3)
XXXXX

Tasks restrictions:
Limited tasks (1)Validation tasks (2)Max level tasks (3)
XXX


Header Identification:

  • account_id - int
  • user_id - int
  • project_id - int

Output:

Example:

{
    "header": {
        "target": "task.trash.List",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}

Objects


Output object - Account (derive from AccountBase)

  • custom_ui - object
  • sharing_actions_disabled - bool
  • auto_trash_deletion - bool
  • mail_upload_disabled - bool
  • tag_creation_disabled - bool
  • community_creation_min_privilege - int
  • advanced_admin_rights - bool
  • disable_wimi_links - bool
  • modules - AccountModules
  • allow_external_guest - bool
  • guests_single_project - bool
  • guest_ratio - int
  • minimum_licenses - int
  • auto_licenses_option - bool
  • nb_licenses - int
  • users_offered - int
  • caldav_url - string
  • is_trial - bool
  • trial_until - date - can be null
  • enable_gocardless - bool
  • enable_auto_invoice - bool
  • has_ogone_alias - bool
  • date_end_subscription - datetime - can be missing
  • has_unpaid_invoice - bool
  • company_size - string - can be null
  • welcome_invite_wish - string - can be null
  • lang - string
  • transport_protocol - string
  • manager_visibility_rights - int - can be null
  • user_visibility_option - int - can be null
  • activity_min_privilege - int
  • airtime_creation_min_privilege - int
  • disable_notifications - int

Output object - AccountBase

  • account_id - int
  • account_name - string
  • company_name - string - can be missing - can be null
  • creation_date - datetime
  • custom_image_id - int - can be null
  • sso_enabled - bool
  • sso_name - string - can be null
  • cover_image_id - int - can be null

Output object - AccountModules

  • channel - bool
  • documents - bool
  • tasks - bool
  • calendar - bool
  • meetings - bool
  • reporting - bool
  • wall - bool - can be missing - can be null
  • activity - bool
  • sign - bool
  • airtime - bool
  • chat - bool
  • api - bool
  • group - bool
  • gantt - bool
  • voxeet - bool
  • coedition - bool
  • social - bool
  • mfa - bool
  • mail - bool
  • webmail - bool

Output object - AccountOther


Output object - AccountSettings

  • incoming_mail_as - string - can be null
  • max_file_version - int
  • admin_user_creation_disabled - bool
  • admin_group_creation_disabled - bool
  • admin_category_creation_disabled - bool
  • allow_support_intervention - bool
  • mail_upload_disabled - bool
  • doc_notif_type - int
  • website - string - can be null
  • locale_id - int
  • company_size - string - can be null
  • password_policy - int
  • entity_type - string
  • phones - LIST of Phone
  • default_project_quota - int - can be null
  • welcome_invite_wish - string - can be null
  • welcome_activity - string - can be null
  • welcome_interest - int - can be null
  • manager_visibility_rights - int - can be null
  • user_visibility_option - int - can be null
  • admin_user_creation_max_privilege - int - can be null

Output object - ActivityEvent


Output object - ActivityEventCalendar (derive from ActivityEventTypeBase)

  • project_id - int
  • event_id - int
  • event_name - string - can be encrypted

Output object - ActivityEventCategory (derive from ActivityEventTypeBase)

  • user_id - int - can be missing
  • category_id - int - can be missing
  • category_name - string - can be missing - can be null - can be encrypted
  • category_old_name - string - can be missing - can be null - can be encrypted
  • member_type_id - int - can be missing - can be null
  • member_id - int - can be missing - can be null

Output object - ActivityEventDirectory (derive from ActivityEventTypeBase)

  • project_id - int
  • dir_id - int
  • dir_name - string - can be encrypted
  • dir_new_name - string - can be missing - can be encrypted
  • target_project_id - int - can be missing - can be null

Output object - ActivityEventDocument (derive from ActivityEventTypeBase)

  • project_id - int
  • file_master_id - int
  • file_name - string - can be encrypted
  • file_new_name - string - can be missing - can be encrypted
  • target_project_id - int - can be missing

Output object - ActivityEventGroup (derive from ActivityEventTypeBase)

  • user_id - int - can be missing
  • group_id - int - can be missing
  • group_name - string - can be missing - can be null
  • member_name - string - can be missing
  • member_type_id - int - can be missing
  • member_id - int - can be missing

Output object - ActivityEventLink (derive from ActivityEventTypeBase)

  • project_id - int
  • link_id - int
  • title - string - can be encrypted
  • url - string - can be encrypted

Output object - ActivityEventMeeting (derive from ActivityEventTypeBase)

  • project_id - int
  • meeting_id - int
  • meeting_name - string

Output object - ActivityEventProject (derive from ActivityEventTypeBase)

  • user_id - int - can be missing
  • project_id - int - can be missing
  • project_name - string - can be missing - can be null - can be encrypted
  • project_old_name - string - can be missing - can be null - can be encrypted
  • member_type_id - int - can be missing - can be null
  • member_id - int - can be missing - can be null
  • third_member_type_id - int - can be missing - can be null
  • third_member_id - int - can be missing - can be null
  • count_file - int - can be missing - can be null

Output object - ActivityEventTask (derive from ActivityEventTypeBase)

  • project_id - int
  • task_id - int
  • label - string - can be encrypted
  • message - string - can be missing
  • status - int - can be missing
  • owner - int - can be missing

Output object - ActivityEventTypeBase

  • subtype - int

Output object - ActivityEventUser (derive from ActivityEventTypeBase)

  • user_id - int - can be null
  • first_name - string - can be encrypted
  • last_name - string - can be encrypted
  • privilege - int - can be missing

Output object - ActivityEventValidation (derive from ActivityEventTypeBase)

  • user_id - int - can be null
  • first_name - string - can be encrypted
  • last_name - string - can be encrypted
  • privilege - int - can be missing

Output object - Address

  • street - string
  • postal_code - string
  • city - string
  • state - string - can be missing - can be null
  • country - string

Output object - AppCommand

  • command - string
  • parameters - string

Output object - Application

  • app_type_id - int
  • app_instance_id - int
  • app_version - string
  • app_identifier - string
  • last_use - datetime

Output object - ApplicationPasswordInfo

  • id - int
  • user_id - int
  • password_name - string
  • password_date_creation - date

Output object - Auth

  • level - int
  • tasks - int
  • documents - int
  • meetings - int
  • reporting - int
  • channel - int
  • calendar - int
  • group_auth - bool

Output object - BillingInfo

  • account_id - float
  • automatic_renewal_date - date - can be null
  • locale_id - string
  • date_format_family - string
  • automatic_renewal - bool
  • bill_name - string - can be null
  • owner - string - can be null
  • email - string - can be null
  • entity_type - string
  • tva - string - can be null
  • total_cost - float
  • payment_periodicity - int
  • tva_rate - float
  • global_discount - float - can be null
  • credits - float
  • currency - string
  • retailer - string - can be null
  • trial_until - datetime - can be null
  • next_payment_date - datetime - can be null
  • users_defined - int
  • users_offered - int
  • total_users - int
  • guest_ratio - int
  • max_guests - int
  • storage_offered - float
  • storage_defined - float
  • total_storage - float
  • offer_id - int
  • address - Address - can be null
  • phones - LIST of Phone
  • is_credit_card_set - bool
  • is_bank_set - bool
  • credit_card - CreditCard - can be null
  • late_payment_days - int

Output object - BlockingPage

  • page_id - int
  • front_id - int
  • name - string

Output object - CalendarEvent

  • all_day - bool - can be missing
  • byday - LIST of string - can be missing
  • bymonth - LIST of int - can be missing
  • bymonthday - LIST of int - can be missing
  • bysetpos - LIST of int - can be missing
  • calendar_event_id - int - can be missing
  • color_id - int - can be missing
  • complete - bool - can be missing
  • count - int - can be missing
  • deleted - bool - can be missing
  • description - string - can be missing - can be null - can be encrypted
  • editable - bool - can be missing
  • end_date - datetime - can be missing
  • etag - int - can be missing
  • exdates - LIST of string - can be missing
  • freq - string - can be missing - can be null
  • interval - int - can be missing - can be null
  • isEvent - bool - can be missing
  • isMeeting - bool - can be missing
  • isTask - bool - can be missing
  • location - string - can be missing - can be null - can be encrypted
  • meetingId - int - can be missing
  • modified_occurrence - bool - can be missing
  • nb_attachments - int - can be missing
  • nb_comments - int - can be missing
  • occurrences - LIST of CalendarEvent - can be missing
  • project_id - int - can be missing
  • recurrence_id - datetime - can be missing
  • recurrence_settings - string - can be missing - can be null
  • reminders - LIST of Reminder - can be missing
  • reminders_hmstr - string - can be missing
  • sequence - int - can be missing
  • start_date - datetime - can be missing
  • taskId - int - can be missing
  • tsklist_color - int - can be missing
  • tsklist_title - string - can be missing - can be encrypted
  • timezone - string - can be missing - can be null
  • title - string - can be missing - can be encrypted
  • uid - string - can be missing
  • user_id - int - can be missing
  • until - datetime - can be missing - can be null
  • url - string - can be missing
  • users - LIST of int - can be missing
  • users_status - LIST of EventUserStatus - can be missing
  • viewable - bool - can be missing
  • is_public - bool - can be missing
  • tags - LIST of int - can be missing

Output object - Category

  • category_id - int
  • category_name - string - can be encrypted
  • category_url_ico - string - can be null

Output object - Chat

  • chat_id - int
  • new_count - int
  • users - LIST of ChatUser
  • user_groups - LIST of UserGroup
  • project_id - int
  • last_message_date - datetime
  • date - datetime
  • last_message_info - struct - can be null
    • content - string
    • has_attachment - bool
    • trash - bool
    • user_id - int
  • name - string - can be null - can be encrypted
  • custom_image_id - int - can be null
  • silent - bool - can be null
  • silent_until - datetime - can be missing - can be null

Output object - ChatFull (derive from Chat)

  • favorites - LIST of int
  • messages_count - int
  • messages - LIST of ChatMessage

Output object - ChatMember

  • member_type_id - int
  • member_id - int

Output object - ChatMessage

  • content - string - can be encrypted
  • enhanced_content - string - can be encrypted
  • date - datetime
  • index - int
  • message_id - int
  • user_id - int
  • edited - bool - can be missing
  • deletion_user - int - can be missing - can be null
  • deletion_date - datetime - can be missing - can be null
  • attachment_id - int - can be missing - can be null
  • attachment - ExternalAttachment - can be missing - can be null
  • internal_attachment - DocumentAttachment - can be missing - can be null
  • links - LIST of string - can be missing
  • integration_attachment - IntegrationAttachment - can be null
  • reactions - LIST of MessageReaction - can be null

Output object - ChatUser

  • user_id - int
  • chat_id - int
  • from_user_group - bool
  • last_seen_count - int - can be missing
  • last_message_seen_id - int - can be missing - can be null

Output object - Comment

  • comment_id - string
  • user_id - int
  • text - string - can be encrypted
  • reactions - LIST of MessageReaction
  • integration_attachment_list - LIST of IntegrationAttachment
  • date - datetime
  • edited - bool
  • deleted - bool - can be missing
  • readers_list - LIST of int

Output object - CommentedItem

  • comment_date - datetime
  • comments_count - int
  • item_id - int
  • item_type_id - int
  • name - string - can be encrypted
  • project_id - int
  • last_seen_message_id - int - can be missing - can be null
  • last_message_info - struct - can be null
    • content - string
    • trash - bool
    • user_id - int
  • new_count - int - can be missing - can be null
  • silent - bool - can be null
  • silent_until - datetime - can be missing - can be null

Output object - CommentedItemCount

  • new_count - int
  • item_id - int
  • item_type_id - int

Output object - Community

  • community_id - int
  • name - string
  • description - string
  • avatar_id - int - can be null
  • background_id - int - can be null
  • post_creation_auth - int
  • subscription_type - int
  • allow_unsubscription - bool
  • allow_guests - bool
  • creation_date - datetime
  • creation_user_id - int
  • archive_user_id - int - can be null
  • archive_date - datetime - can be null
  • user_id_list - LIST of int
  • auth_list - LIST of MemberAuth
  • view_members_auth - int
  • is_favorite - bool
  • role - int - can be null

Output object - CommunityPost

  • community_post_id - int
  • community_id - int
  • content_type - int
  • comments_enabled - bool
  • comments - LIST of Comment
  • is_pinned - bool
  • is_favorite - bool
  • is_new - bool
  • last_seen_comment_id - int
  • edition_user_id - int - can be null
  • edition_date - datetime - can be null
  • content - string
  • enhanced_content - string
  • reactions - LIST of MessageReaction
  • read_by - int
  • integration_attachment_list - LIST of IntegrationAttachment
  • creation_user_id - int
  • creation_date - datetime
  • external_attachments - LIST of ExternalAttachment
  • poll_id_list - LIST of int

Output object - CreditCard

  • credit_card_id - int
  • number - string
  • holder - string
  • exp_year - string
  • exp_month - string
  • cvc - string - can be missing

Output object - CustomDepartmentListItem

  • label - string
  • position - int

Output object - Directory

  • name - string - can be encrypted
  • date - datetime
  • auth - int
  • dir_id - int
  • parent_id - int - can be null
  • project_id - int
  • path_names - LIST of string - can be missing
  • sharing_invisible_subs - bool - can be missing - can be null
  • sharing_allow_upload - bool - can be missing - can be null
  • sharing_code - string - can be missing - can be null
  • sharing_user_id - int - can be missing - can be null
  • sharing_password - string - can be missing - can be null
  • sharing_expiration_date - datetime - can be missing - can be null
  • nb_dirs - int - can be missing
  • nb_files - int - can be missing
  • is_read_only - bool - can be null
  • access_type_default - int
  • lowest_parent_access_type - int
  • comment_count - int - can be missing - can be null
  • properties - Property
  • cloud_service - string - can be null
  • cloud_reference - string - can be null

Output object - DocValidationRequest

  • request_id - int
  • file_data - struct
    • project_id - int
    • file_master_id - int
    • file_version_id - int
    • file_name - string
    • path_names - LIST of string
  • user_id - int
  • creation_date - datetime
  • expiry_date - datetime - can be missing - can be null
  • status - int
  • change_date - datetime - can be missing - can be null
  • description - string - can be null - can be encrypted
  • trash - int - can be missing
  • doc_validation_responses - LIST of DocValidationResponse

Output object - DocValidationResponse

  • response_id - int
  • request_id - int
  • file_version_id - int - can be missing - can be null
  • user_id - int
  • status - int
  • comment - Comment - can be missing - can be null
  • change_date - datetime - can be missing - can be null
  • trash - int - can be missing

Output object - DocumentAttachment (derive from FileBase)

  • attachment_id - int
  • project_id - int
  • doc_id - int
  • doc_type - string
  • item_type - string
  • item_id - int
  • public_url - string - can be null
  • inapp_url - string
  • preview_status - int
  • file_display_list - LIST of struct
    • preview_type - string
    • preview_status - string
  • trash - bool - can be missing

Output object - DocumentTreeEntry

  • entry_id - int
  • entry_parent_id - int - can be null
  • entry_name - string
  • entry_path - string - can be null
  • entry_type - string

Output object - Error

  • id - int
  • str - string
  • detail_id - int - can be null
  • detail_str - string
  • debug_msg - string - can be missing
  • trad_error - string - can be missing - can be null
  • data - object - can be missing
  • success - bool - can be missing

Output object - EventUserStatus

  • id_user - int
  • invite_status - int

Output object - ExternalAttachment (derive from FileBase)

  • attachment_id - int
  • md5 - string - can be missing - can be null
  • file_display_list - LIST of struct
    • preview_type - string
    • preview_status - string
  • file_timestamp - datetime - can be missing

Output object - ExternalUser

  • id - int
  • email - string
  • first_name - string
  • last_name - string
  • account_id - int

Output object - File (derive from FileBase)

  • info - string - can be missing
  • enhanced_info - string - can be missing
  • preview_status - int
  • file_display_list - LIST of struct
    • preview_type - string
    • preview_status - string
  • cloud_service - string - can be null
  • cloud_service_data - object - can be null
  • gdocs - string - can be null
  • version - int
  • version_id - int - can be missing - can be null
  • is_head - bool
  • file_id - int
  • file_master_id - int
  • dir_id - int - can be null
  • project_id - int
  • trash_date - datetime - can be null
  • trash_user_id - int - can be null
  • status - int - can be null
  • path_names - LIST of string - can be null
  • path_ids - LIST of int - can be null
  • lock - struct - can be null
    • lock_user_id - int
    • lock_date - datetime
    • exclusive - bool
  • user_editing - LIST of int - can be null
  • sharing - struct - can be null
    • sharing_code - string
    • sharing_user_id - int - can be null
    • sharing_password - string - can be null
    • sharing_expiration_date - datetime - can be null
  • comment_count - int - can be missing
  • tags - LIST of Tag
  • properties - Property
  • doc_validation_request - DocValidationRequest - can be missing - can be null

Output object - FileBase

  • name - string - can be encrypted
  • extension - string
  • size - int - can be missing - can be null
  • date - datetime
  • user_id - int

Output object - FileEvent

  • activity_event_id - int
  • date - datetime
  • event_type - int
  • user_id - int
  • item_id - int
  • directory_id - int
  • file_name - string
  • event_data - FileEventData - can be null

Output object - FileEventData

  • file_new_name - string - can be missing
  • validation_response_status - int - can be missing - can be null
  • validation_request_status - int - can be missing - can be null
  • validation_expiry_date - datetime - can be missing
  • validator_id - int - can be missing

Output object - FileListPathDirId

  • path - string
  • dir_id - int

Output object - FileMetadata

  • key - string
  • value - string - can be null

Output object - Filter

  • filter_id - int
  • module - string
  • name - string
  • slug - string
  • filters - object
  • account_id - int
  • project_id - int - can be null
  • user_id - int
  • creation_date - datetime
  • creation_user - int
  • update_date - datetime - can be null
  • update_user - string - can be null

Output object - GandiDomain

  • id - int
  • fqdn - string
  • antispam - bool
  • auto_renew - bool
  • expiration_date - date

Output object - GanttLink

  • source_id - int
  • target_id - int
  • item_type - int
  • relation_type_id - int
  • project_id - int - can be missing - can be null

Output object - GeneralFileTemplate

  • file_template_id - int
  • general_file_id - int
  • name - string
  • description - string
  • enhanced_description - string
  • creator_id - int
  • creation_date - datetime
  • extension - string
  • tags - LIST of int - can be missing
  • file_display_list - LIST of struct
    • preview_type - string
    • preview_status - string

Output object - GroupMember

  • account_id - int
  • user_group_id - int
  • member_type_id - int
  • member_id - int

Output object - IntegrationAttachment

  • integration_attachment_id - int
  • type - string
  • title - string - can be null - can be encrypted
  • title_link - string - can be null - can be encrypted
  • image_url - string - can be null
  • thumbnail_url - string - can be null
  • text - string - can be null - can be encrypted
  • author_name - string - can be null - can be encrypted

Output object - Invoice

  • invoice_id - int
  • invoices_number - int
  • amount - float
  • vat - float
  • amount_ttc - float
  • balance - float
  • credits_earned - float
  • creation_date - datetime
  • quotation_ref - string - can be null
  • transaction_type - int
  • nb_months - int - can be null
  • is_payed - bool
  • currency_symbol - string

Output object - Link

  • link_id - int
  • project_id - int
  • user_id - int
  • url - string - can be encrypted
  • title - string - can be encrypted
  • description - string - can be encrypted
  • enhanced_description - string - can be encrypted
  • creation_date - datetime
  • change_date - datetime - can be null
  • item_type_id - int
  • item_id - int
  • comment_count - int - can be missing - can be null
  • tags - LIST of Tag
  • trash_date - datetime - can be null
  • trash_user_id - int - can be null
  • path_names - LIST of string - can be null
  • path_ids - LIST of int - can be null
  • file_display_list - LIST of struct
    • preview_type - string
    • preview_status - string

Output object - LinkEvent

  • event_id - int
  • date - datetime
  • event_type - int
  • user_id - int
  • title - string
  • url - string

Output object - Mailbox

  • id - int
  • domain_id - int
  • address - string
  • mailbox_type - string
  • creation_date - datetime
  • mailbox_uuid - string
  • owners - LIST of int
  • aliases - LIST of string - can be null
  • password_set - bool
  • created_by - int
  • status - int - can be missing - can be null

Output object - MailboxPackage

  • id - int
  • name - string
  • count - int
  • price - int - can be null
  • price_per_mailbox - int - can be null
  • discount - int - can be null

Output object - MailboxStorageQuota

  • mailbox_uuid - string
  • quota_used - int

Output object - Meeting

  • meeting_id - int
  • user_id - int
  • project_id - int
  • meeting_date_id - int - can be null
  • name - string
  • place - string
  • description - string - can be null
  • status - int - can be null
  • user_id_list - LIST of struct
    • user_id - int
    • participant_id - int
    • first_name - string - can be null
    • last_name - string - can be null
  • ext_user_list - LIST of struct
    • participant_id - int
    • ext_email - string - can be null
    • ext_info - string - can be null
  • dates - LIST of struct
    • date_id - int
    • datetime_start - datetime
    • datetime_end - datetime
  • availabilities - LIST of struct
    • user_id - int
    • date_id - int
    • status - int

Output object - MemberAccess

  • member_id - int
  • member_type_id - int
  • access - bool
  • restricted_access_type - int - can be null
  • herited_access - bool - can be null
  • herited_access_type - bool - can be null

Output object - MemberAuth

  • member_id - int
  • member_type_id - int
  • auth - int

Output object - MessageReaction

  • code - string
  • user_id_list - LIST of int

Output object - Offer

  • offer_id - int
  • name - string
  • price_per_user - float
  • price_per_go - float
  • package_price - float - can be null
  • is_configurable - bool
  • is_quote - bool
  • is_package - bool
  • is_selectable - bool
  • is_obsolete - bool
  • min_users - int
  • min_storage - int
  • min_projects - int
  • max_users - int
  • max_guests - int
  • guest_ratio - int
  • allow_guests - bool
  • max_storage - int
  • max_projects - int
  • currency - string
  • current - bool
  • priority - int
  • sponsor - struct
    • sponsored_bonus - int
    • sponsor_bonus - int
    • sponsor_bonus_limit - int
  • trial_duration - int
  • trial_users - int
  • bypass_cb_tuto - bool

Output object - Pagination

  • batch_size - int
  • total_count - int
  • page_count - int
  • count_per_project - LIST of struct - can be missing
    • project_id - int
    • count - int

Output object - PayingServicesAccount

  • id - int
  • service_name - string
  • description_trad - string
  • free_threshold_value - int - can be missing
  • nb_item_activated - int
  • debit_type - string
  • debit_value - int
  • monthly_cost - float
  • project_id_list - LIST of int

Output object - PersistentRoom

  • room_id - string
  • name - string
  • image_type - string
  • image_id - int
  • account_id - int
  • jitsi_id - string - can be missing
  • participants - LIST of object - can be missing
  • unavailable - bool - can be missing
  • scope - int
  • creation_user_id - int

Output object - PersonalizedEntry

  • id - int
  • account_id - int
  • name - string
  • personalized_entry_type_id - int - can be missing
  • name_type - string - can be missing
  • position - int
  • choices - LIST of PersonalizedEntryChoice

Output object - PersonalizedEntryAccess

  • access - string
  • auth - bool

Output object - PersonalizedEntryAuth


Output object - PersonalizedEntryChoice

  • choice_id - int
  • choice_label - string - can be null
  • choice_position - int - can be null
  • selected - bool - can be missing

Output object - PersonalizedEntryProjectAuth


Output object - PersonalizedEntryProjectGlobalAccess


Output object - PersonalizedEntryProjectModule

  • module - string
  • module_id - int

Output object - PersonalizedEntryValue

  • id - int
  • name - string
  • personalized_entry_type_id - int
  • raw_value - string - can be null
  • choices - LIST of PersonalizedEntryChoice

Output object - Phone

  • phone_id - int - can be missing
  • code - string
  • phone - string
  • type - string

Output object - Poll

  • poll_id - int
  • type - string
  • content - string
  • enhanced_content - string
  • options - LIST of struct
    • poll_option_id - int
    • content - string
    • is_correct - bool - can be missing
  • user_answers - LIST of PollAnswer
  • answers - LIST of PollAnswer
  • voter_count - int
  • is_anonymous - bool
  • allow_multiple_answers - bool
  • allow_user_option - bool
  • disable_answer_edition - bool
  • hide_results - bool
  • end_date - datetime - can be null
  • creation_user_id - int

Output object - PollAnswer

  • poll_option_id - int
  • user_id - int - can be null
  • weight - int - can be missing

Output object - PrettyTask

  • task_id - int
  • label - string
  • list_label - string
  • description - string - can be null
  • duration - string - can be null
  • is_started - bool
  • is_completed - bool
  • creation_date - datetime
  • creation_user - string
  • begin_date - date - can be null
  • due_date - date - can be null
  • start_date - datetime - can be null
  • start_user - string - can be null
  • completion_date - datetime - can be null
  • completion_user - string - can be null
  • accepted_date - datetime - can be null
  • accepted_user - string - can be null
  • update_date - datetime - can be null
  • status - string
  • owners - LIST of string - can be missing
  • tags - LIST of string - can be missing

Output object - Project

  • project_id - int
  • account_id - int
  • category_id - int
  • custom_image_id - int - can be null
  • url_image - string - can be null
  • name - string - can be encrypted
  • info - string - can be encrypted
  • enhanced_info - string - can be encrypted
  • archive - bool
  • trash - bool
  • slug - string
  • email_prefix - string - can be null
  • category_name - string
  • chat_id - int
  • belong - bool
  • stats - ProjectStats - can be null
  • auth - Auth - can be null
  • member_id_list - struct - can be missing - can be null
    • user_id_list - LIST of int - can be missing - can be null
    • user_group_id_list - LIST of int - can be missing - can be null
  • user_id_list - LIST of int - can be missing - can be null
  • disable_wd_sync - bool
  • documents_size - int - can be missing
  • owner_user_id - int - can be null
  • modules - struct - can be missing
    • documents - int
    • tasks - int
    • meetings - int
    • reporting - int
    • calendar - int
    • channel - int
    • activity - int
  • default_module - string
  • tags - LIST of Tag
  • creation_date - date
  • start_date - date - can be null
  • end_date - date - can be null
  • storage_quota - int - can be null
  • family_tag_id_restricted - LIST of int
  • project_tree_lock_user_id - int - can be null
  • project_tree_lock_date - datetime - can be null
  • business_hour_start_datetime - datetime - can be missing - can be null
  • business_hour_end_datetime - datetime - can be missing - can be null
  • business_hour_enable_weekend - int - can be missing
  • is_favorite - bool
  • color_id - int - can be null

Output object - ProjectAuth

  • project_id - int
  • auth - Auth
  • user_id - int - can be missing - can be null

Output object - ProjectStats

  • project_id - int - can be missing
  • document_count - int - can be missing
  • reunion_count - int - can be missing
  • contributor_count - int - can be missing
  • agenda_count - int - can be missing
  • calendar_count - int - can be missing
  • todo_count - int - can be missing
  • todo_late - int - can be missing
  • todo_led - string - can be missing
  • total_tasks - int - can be missing
  • completed_tasks - int - can be missing

Output object - ProjectTemplate

  • key - string
  • name - string
  • folders - object - can be null

Output object - Property

  • property_id - int
  • property_label - string - can be missing
  • property_type - int
  • value - string

Output object - Reminder

  • value - int
  • unit - string
  • date_label - int - can be missing

Output object - Right

  • right_id - int
  • project_id - int
  • module - int
  • module_code - string
  • code - string
  • write - bool

Output object - SearchQuery

  • general_account_id - int - can be missing
  • query - string
  • max - datetime

Output object - SearchResult


Output object - SearchResultEntity

  • count - int
  • results - LIST of object

Output object - Sharing

  • account_id - int
  • doc_id - int
  • item_type - int
  • code - string
  • user_id - int
  • date_start - datetime
  • invisible_subs - bool
  • allow_upload - bool

Output object - SignatoryBook

  • signatory_book_id - int
  • title - string
  • user_list - LIST of object
  • is_private - int

Output object - Signature

  • display_name - string - can be missing
  • user_list - LIST of object
  • sign_mode - string - can be missing
  • external_attachment - ExternalAttachment
  • deletion_date - date - can be missing

Output object - SignatureGcuAcceptance

  • user_id - int - can be missing
  • accepted_date - date - can be missing

Output object - SignaturePackage

  • id - int - can be missing
  • name - string - can be missing
  • description_trad - string - can be missing
  • number_signatures - int - can be missing
  • price - float - can be missing
  • increased_price - float - can be missing
  • monthly_consumption - int - can be missing
  • last_reset_date - date - can be missing
  • deletion_date - date - can be missing
  • payment_frequency - string - can be missing

Output object - Subtask

  • label - string - can be encrypted
  • completion_date - datetime - can be null
  • completion_user - int - can be null
  • position - int
  • subtask_id - int
  • owner_id - int
  • owners - LIST of int - can be missing

Output object - Tag

  • wimi_id - int
  • tag_id - int
  • label - string - can be encrypted
  • color - int
  • project_id - int - can be missing
  • usage_total - int - can be missing
  • usage_tasks - int - can be missing
  • usage_docs - int - can be missing
  • tag_family - LIST of int - can be missing

Output object - TagFamily

  • id - int
  • label - string - can be null
  • account_id - int
  • tag_list - LIST of int

Output object - TagReporting

  • tag_id - int
  • label - string - can be encrypted
  • nb_done - int
  • nb_started - int
  • nb_not_started - int
  • last_update - date - can be null

Output object - TagStats

  • label - string - can be encrypted
  • color - int
  • tag_id - int
  • file_id_list - LIST of int
  • project_id_list - LIST of int
  • task_id_list - LIST of int
  • user_id_list - LIST of int
  • total_count - int
  • family_id - LIST of int

Output object - Task

  • label - string - can be encrypted
  • description - string - can be null - can be encrypted
  • enhanced_description - string - can be null - can be encrypted
  • weight - float - can be null
  • weight_unit - string
  • position - int
  • is_started - bool
  • is_completed - bool
  • creation_date - datetime
  • creation_user - int
  • begin_date - datetime - can be null
  • due_date - datetime - can be null
  • start_date - datetime - can be null
  • start_user - int - can be null
  • completion_date - datetime - can be null
  • completion_user - int - can be null
  • accepted_date - datetime - can be null
  • accepted_user - int - can be null
  • update_date - datetime - can be null
  • task_id - int
  • project_id - int - can be missing
  • status - int
  • task_list_id - int
  • owners - LIST of int - can be missing
  • tags - LIST of int - can be missing
  • reminders - LIST of Reminder - can be missing
  • recurrence - TaskRecurrence - can be null
  • recurrence_date - datetime - can be null
  • nb_subtasks - int - can be missing - can be null
  • nb_docs - int - can be missing - can be null
  • nb_comments - int - can be missing - can be null
  • trash - int - can be missing - can be null
  • trash_user_id - int - can be missing - can be null
  • trash_date - datetime - can be missing - can be null
  • external_attachments - LIST of ExternalAttachment - can be missing
  • document_attachments - LIST of DocumentAttachment - can be missing

Output object - TaskEdition

  • label - string - can be missing
  • description - string - can be missing
  • task_list_id - string - can be missing
  • status - string - can be missing
  • begin_date - datetime - can be missing - can be null
  • due_date - datetime - can be missing - can be null
  • weight - float - can be missing - can be null
  • weight_unit - string - can be missing
  • reminders - LIST of Reminder - can be missing
  • owners - LIST of int - can be missing

Output object - TaskHistory

  • event_id - int
  • user_id - int
  • event_time - int
  • event_type - string
  • event_data - struct
    • is_completed - bool - can be missing
    • completion_user - int - can be missing
    • completion_date - datetime - can be missing
    • accepted_user - int - can be missing
    • accepted_date - datetime - can be missing
    • message - string - can be missing
    • list - int - can be missing
    • label - string - can be missing
    • owners - LIST of int - can be missing
    • task - int - can be missing
    • subtask - int - can be missing
    • owner - int - can be missing
    • old_status - int - can be missing
    • new_status - int - can be missing
    • old_list - int - can be missing
    • new_list - int - can be missing
    • old_pos - int - can be missing
    • new_pos - int - can be missing
    • tsk_status_id - int - can be missing
    • is_started - bool - can be missing
    • start_user - int - can be missing
    • start_date - date - can be missing
    • fields - struct - can be missing
      • tsk_status_id - int - can be missing
      • is_started - bool - can be missing
      • start_user - int - can be missing
      • start_date - datetime - can be missing
      • is_completed - bool - can be missing
      • completion_user - int - can be missing
      • completion_date - datetime - can be missing
      • accepted_user - int - can be missing
      • accepted_date - datetime - can be missing
      • position - int - can be missing
    • added - LIST of int - can be missing
    • removed - LIST of int - can be missing
    • description - string - can be missing
    • weight_unit - string - can be missing
    • weight - float - can be missing - can be null
    • due_date - datetime - can be missing - can be null
    • begin_date - datetime - can be missing - can be null
    • old_task - int - can be missing
    • new_task - int - can be missing
    • old_label - string - can be missing
    • new_label - string - can be missing
    • task_list_id - int - can be missing
    • position - int - can be missing
    • data - struct - can be missing
      • label - string - can be missing
      • owner_id - int - can be missing
    • attachment_name - string - can be missing
    • tag_label - string - can be missing
  • event_date - datetime

Output object - TaskList

  • color - int
  • label - string - can be encrypted
  • position - int
  • project_id - int
  • task_list_id - int
  • hidden - bool - can be missing
  • start_date - datetime - can be null
  • end_date - datetime - can be null
  • line - int - can be null
  • exclude_validated_task - int
  • trash - int - can be missing - can be null
  • trash_user_id - int - can be missing - can be null
  • trash_date - datetime - can be missing - can be null
  • total_tasks - int
  • total_tasks_duration - float
  • finished_tasks - int
  • finished_tasks_duration - float
  • not_started_tasks - int - can be null
  • in_progress_tasks - int - can be null
  • rejected_tasks - int - can be null
  • accepted_tasks - int - can be null
  • accepted_tasks_duration - float - can be null
  • late_tasks - int
  • tasks - LIST of Task - can be missing

Output object - TaskListLink

  • source_tsk_list_id - int
  • target_tsk_list_id - int
  • relation_type_id - int

Output object - TaskListUserStat

  • user_id - int
  • task_list_id - int
  • total_tasks - int
  • total_tasks_duration - float - can be null
  • accepted_tasks - int
  • accepted_tasks_duration - float - can be null
  • finished_tasks - int
  • finished_tasks_duration - float - can be null

Output object - TaskPositionChange

  • task_id - int
  • previous_position - int
  • previous_list_id - int

Output object - TaskRecurrence

  • recurrence_id - int
  • start_date - datetime
  • creation_trigger_days - int
  • freq - string
  • count - int
  • until - datetime - can be null
  • interval - int
  • byday - LIST of string
  • bymonthday - LIST of int
  • bymonth - LIST of int
  • bysetpos - LIST of int

Output object - TaskStatus

  • status_id - int
  • code - string
  • next - LIST of int

Output object - TaskWeightUnit

  • unit - string
  • label - string

Output object - User (derive from UserBase)

  • user_id - int
  • display_name - string
  • custom_image_id - int - can be null
  • skype - string - can be missing - can be null
  • company_name - string - can be null - can be encrypted
  • department - string - can be encrypted
  • title - string - can be null - can be encrypted
  • trash - bool
  • deleted - bool
  • role - int
  • gapps_uid - int
  • saml_id - string - can be null
  • initials - string
  • timezone - string
  • token_ttl_mins - int
  • password_enabled - bool
  • phones - LIST of Phone
  • status - string - can be missing - can be null
  • tags - LIST of Tag
  • last_connexion - date - can be missing - can be null
  • date_create - date - can be missing - can be null
  • owner_user_id - int - can be missing - can be null
  • double_auth - bool
  • request_signature_enabled - bool
  • has_application_password - bool

Output object - UserAuth

  • user_id - int
  • auth - Auth

Output object - UserBase

  • first_name - string - can be encrypted
  • last_name - string - can be encrypted
  • name - string
  • email - string - can be null

Output object - UserGroup (derive from UserGroupBasic)

  • user_id_list - LIST of int
  • user_group_id_list - LIST of int
  • user_trashed_id_list - LIST of int

Output object - UserGroupAuth

  • user_group_id - int
  • auth - Auth

Output object - UserGroupBasic

  • user_group_id - int
  • account_id - int
  • name - string
  • creation_user_id - int
  • tags - LIST of Tag

Output object - UserProperty

  • account_id - int
  • user_id - int
  • project_id - int - can be null
  • property_type_id - int
  • property_type_name - string
  • property_value - string

Output object - UserService (derive from UserBase)

  • user_ref - string
  • company_name - string - can be missing - can be null

Output object - UserServiceInfo

  • link_id - string - can be missing
  • auth_url - string - can be missing

Output object - WebmailAccount

  • email - string
  • description - string
  • imap_host - string
  • imap_port - int
  • imap_login - string
  • imap_use_ssl - bool
  • smtp_host - string
  • smtp_port - int
  • smtp_login - string
  • smtp_use_ssl - bool
  • is_internal - bool

Output object - WimiItem

  • item_type_id - int
  • item_id - int

Output object - WimiProjectTemplate

  • project_id - int
  • project_template_name - string
  • project_template_description - string - can be null
  • project_template_custom_image_id - int - can be null
  • tag_list - LIST of string

Output object - Workload

  • nb_done - int
  • nb_todo - int
  • hours_done - float
  • hours_todo - float
  • nb_total - int
  • percent_done_nb - float
  • hours_total - float
  • percent_done_hours - float

Errors

Error ID Error traduction
400 api.error.400
401 api.error.401
403 api.error.403
404 api.error.404
405 api.error.405
409 api.error.409
423 api.error.423
500 api.error.500
1000 api.error.1000
1001 api.error.1001
1002 api.error.1002
1003 Uploaded file is not an image
1010 api.error.1010
1020 api.error.1020
1022 api.error.1022
1023 api.error.1023
1024 No account found with this login and password.
1026 api.error.1026
1027 api.error.1027
1028 api.error.1028
1029 A directory with the same name already exists.
1030 You don't have sufficient rights for this action.
1031 Destination is a system directory.
1032 Unable to perform this action on a system directory.
1033 Unable to perform this action on the directory itself or one of its subdirectories.
1034 This action has no effect.
1035 Unable to perform this action, the maximum number of subdirectories has been reached.
1036 Name is missing.
1038 Name is incorrect.
1039 This file cannot be uploaded to the service.
1040 Wimi space usage exceeded!
1041 Wimi space usage exceeded!
1042 Impossible to perform this action on a locked file.
1043 A file with the same name already exists
1044 Cannot proceed: one or more files you are trying to import are read-only.
1045 You do not have the rights to access the service.
1046 api.error.1046
1047 api.error.1047
1048 api.error.1048
1049 api.error.1049
1050 You have reached the workspace quota for this account
1051 This workspace name isn't available, please choose another one
1052 api.error.1052
1053 api.error.1053
1054 api.error.1054
1055 A workspace with the same name already exists.
1056 api.error.1056
1057 The total size of files to be archived is above the allowed limit!
1058 Could not proceed: all activities linked to files and folders sharings have been disabled for this account.
1059 Invalid user!
1060 Bad gender given
1061 Bad email given
1062 An account already uses this email
1063 A user already exists with this information
1064 Self test user
1065 First name too short or too long
1066 Last name too short or too long
1067 Company name too short or too long
1068 User quota exceeded for this account
1069 Missing password
1070 First name missing
1071 Last name missing
1072 Workspace name missing
1073 This user is not authorized to perform this action
1099 You do not have sufficient rights to add {first_name} {last_name} as Administrator
1074 One or more users could not be imported
1075 The file must be a CSV
1076 You cannot deactivate yourself!
1077 You cannot delete yourself!
1078 This user could not be found...
1079 This filter could not be found...
1080 Bad index in import file.
1081 One or more indexes are missing in the import file.
1082 The list cannot be deleted if it still contains tasks.
1083 The list title cannot exceed 48 characters.
1096 api.error.1096
1084 A label cannot be empty.
1085 The length of the label is too long
1086 A category already exists with this name
1087 api.error.1087
1088 The file must be a XLS or XLSX
1089 Invalid url format
1090 api.error.1090
1091 api.error.1091
1092 api.error.1092
1093 api.error.1093
1094 api.error.1094
1095 Unable to perform this action on the directory itself or one of its subdirectories : {folders}
1100 Bad account name
1108 This action is not possible in an archived workspace
1101 Account name already used
1102 Password too short
1103 This organization name is already used by another account
1104 Bad sponsor
1105 No offer found with this ID
1106 Your password is not complex enough. It needs to have atleast one upper et lower case letter as well as a number or a symbol
1107 Your password has already been used
1109 This label already exist
1110 The task does not exist
1111 A list already exists with this label
1112 The task "{task_name}" still has non accepted subtask
1113 The following tasks have one or several unfinished subtasks: {task_name}
1114 Subtask status cannot be changed once the task is completed
1115 This task is trashed
1116 This task does not belong to this workspace
1117 The task list does not exist.
1120 The password expired
1121 api.error.1121
1122 api.error.1122
1130 The folder has not been found
1140 An error occurred while renaming the tag
1141 An error occurred while merging the tags
1142 An error occurred while removing the tag
1143 An error occurred while creating the tag
1144 The tag "{label}" exceeds the length limit of 48 characters
1145 api.error.1145
1146 api.error.1146
1147 api.error.1147
1148 api.error.1148
1149 api.error.1149
1155 The tag {tag_name} does not belong to the workspace restricted tag family {family_tag_name}
1156 Family tag already exists
1150 An error occurred while adding the property
1151 An error occurred while removing the property
1160 You do not have the rights to change this document validation request
1161 This request cannot accept responses (either because it is complete, or because it has been put on hold)
1162 You do not have the rights to update this response
1163 You cannot add validators to a completed request
1170 api.error.1170
1171 Payment refused by the bank
1172 api.error.1172
1173 api.error.1173
1174 api.error.1174
1175 Insufficient credits
1176 Credit card expired
1177 api.error.1177
1178 api.error.1178
1179 api.error.1179
1180 api.error.1180
1181 api.error.1181
1182 api.error.1182
1183 api.error.1183
1184 api.error.1184
1185 api.error.1185
1186 api.error.1186
1187 Missing credit card
1188 api.error.1188
1189 Error during payment. Error ID: {ncerror}
1190 The number of workspaces, users or storage volume used by your Wimi does not allow you to select this offer.
1191 Invalid data format
1192 The chosen number of users is less than the minimum number of users of your plan
1193 The chosen storage is less than the minimum storage of your plan
1194 The chosen number of users exceeds the maximum number of users for your plan
1195 The chosen storage exceeds the maximum storage of your plan
1196 The number of active users in this account exceeds the number you entered
1197 The storage used by this account exceeds the one you entered
1198 api.error.1198
1199 api.error.1199
1200 Some billing information are missing. Please complete them before performing a payment.
1201 The given Intra. VAT number is wrong
1210 The information on the credit card are incomplete
1211 Bad CVC format
1212 Bad credit card number
1220 api.error.1220
1221 api.error.1221
1222 api.error.1222
1223 You cannot create a chat with this user
1230 The field must contain less than 127 characters, cannot contain < > ; : " / \ | ? * and cannot begin or end with .
1231 It is forbidden to import a folder if one of its elements contains one of these characters: < > ; : " / \\ | ? * or begin / end with a .
1240 Invalid phone number
1242 There is a pending payment. Two transfers canno't occur at the same time
1243 The bank transfer service is currently unavailable
1250 The workspace to duplicate has too many files and folders
1251 The total file size to duplicate exceeds the allowed limit
1252 A task end date is necessary to create a reminder
1254 A task begin date is necessary to create a reminder
1253 Maximum reminders reached for this task
1260 A group already exists with this name
1261 Impossible to add the member(s) : at least two groups are linking each others
1280 The task has not been generated because it exceeds its recurrence limit (end date or count)
1281 The recurrence start date cannot be above its end date
1300 The value of this field cannot be below {value}
1301 The value of this field cannot be above {value}
1380 The street is missing
1381 The postal code is missing
1382 The city is missing
1383 The country is missing
1384 The state is missing
1350 You cannot remove all members of a directory
1351 You don't have the required access rights for this directory
1352 You do not have access to this document
1353 api.error.1353
1354 api.error.1354
1375 The event does not exist
1404 api.error.1404
1423 api.error.1423
1425 The property does not exist
1430 This sharing link is expired or does not exist
1440 A guest user cannot participate in more than one workspace
1441 api.error.1441
1442 Guest quota exceeded for this account
1443 The number of licenses does not comply with the guest ratio associated to this account
1450 api.error.1450
1451 The list start date cannot be above or equal its end date
1452 You cannot add a circular link
1453 A link already exists between these two lists
1454 One or more selected lists contains scheduled tasks
1470 Error connecting to third party service
1471 An error occured while fetching the file from the third party
1480 Unable to proceed with "{item_name}". Storage quota on the "{target_project_name}" is exceeded.
1490 There must be at least one user (excluding group) with modification right per workspace
1491 Cloning user is forbidden if the "admin workspace access" is set to "advanced"
1500 You can't change someone else's email
1501 This item does not belong to this workspace
1510 The creator of this conference is not yet connected. Please try to connect later.
1600 The provided current password is not correct
1601 This action is not authorized on a deactivated user
1650 Wimi is currently facing some internal issues. Please try again in few minutes
1651 api.error.1651
1530 No password recovery query has been found with this link. Note that a provided password recovery link can only be used once.
1531 The update recovery token has already been used for this password.
1550 api.error.1550
1551 api.error.1551
1602 This user is deactivated
1603 Incorrect password
1604 Missing account name
1610 api.error.1610
1611 api.error.1611
1612 This custom field has not been added to workspace
1613 api.error.1613
1614 api.error.1614
1615 api.error.1615
1661 Warning, this service cannot be activated on a free account
1700 The file you are trying to download is trashed
1701 File detected as malicious
2021 The file is currently being saved, please try again in a few seconds...
2022 api.error.2022
2023 This file is not eligible for online edition
2501 The maximum number of mailboxes has been exceeded
2502 This pack does not have enough mailbox
2503 Your billing information is not complete
2504 A mailbox with the same name already exists.
2506 The postal code does not seem to be valid for the selected country.
2601 A mailbox with the same address already exists
2701 api.error.2701
unmapped error code api.error.unmapped error code
1750 You cannot use emojis in your workspace name
1752 The user limit has been reached for this worspace
1753 This action cannot be done on a locked folder tree
1801 A document template already exists with this name
2301 The end date cannot be before the current date
2201 This name is already taken.
1751 Password too long
1758 You cannot disable multi-factor authentication for an administrator.
2401 api.error.2401