ASP.NET Web API Help Page

Get Access Control settings for the village

Set Access Control settings for the village

Change (or set, if no password is set) the logged-in user's password

Remove a social login from the user's account

Add a social login to the user's account

Sets the Google Cloud Messaging (GCM) id for the user/device

Clears the Google Cloud Messaging (GCM) id for the user/device

Sets the Apple Push Notification Service (APNS) id for the user/device

Clears the Apple Push Notification Service (APNS) id for the user/device

Callback for Adapty webhook

Get list of advertisements for the village

Download the advertisement image for the specified ad

Track advertisement click

Track advertisement view

Get advertisement interval for journals

Get AI chat history for the user

Post a new AI chat history message

Clear AI chat history for the user

Proxy to OpenAI Chat

Sign up using Apple authentication

Sign in using Apple authentication

Get the specified village's avatar.

Sets the avatar for the specified village. This method must be called with multipart/form-data encoding for the file.<br><br> The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "avatar": <ul> <li>Content-Disposition: form-data; name="avatar"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Delete the avatar for the specified village

Get the default avatar for places where a user-specific avatar is not applicable

Get the specified user's avatar.

Sets the avatar for the logged-in user. This method must be called with multipart/form-data encoding for the file.<br><br> The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "avatar": <ul> <li>Content-Disposition: form-data; name="avatar"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Delete the avatar for the logged-in user

Get Care Plan Definitions (all versions)

Get Care Plan Definitions (active versions only)

Get specified Care Plan Definition (active version only)

Get specified Care Plan Definition (all versions)

Get specified Care Plan Definition version

Get all Care Plan instances

Get all Care Plan instances for the specified care plan

Get Care Plan instances for the current date

Get Care Plan instances for the current date

Save the care plan (may result in a new plan being created)

Answer a care plan question

Delete a care plan

Return all checklists in all categories for this village (full data dump)

Return a list of Checklist Categories to the specified depth, with Village data

Return a single Checklist Category to the specified depth, with Village data

Returns a list of Checklists in the specified category, to the specified depth, with Village data

Returns a single Checklist to the specified depth, with Village data

Returns a list of Checklist Items in the specified Checklist, with Village data

Returns a list of the village's checklist answers for the specified checklist

Returns a list of the village's checklist answers for all checklists

Sets the status of one or more items in a checklist

Get the list of conditions selected for the village

Set village conditions

Get all conditions available for selection

Get Contact Categories

Get Contact Info Types

Get all contacts

Create a new contact

Import multiple contacts

Edit an existing contact

Delete a contact

Get a list of conversations in the village

OBSOLETE

Gets messages in the specified conversation. If MessageId is NOT provided (or is the same as the user's last-read message) AND SortDirection = Asc, the user's last-read indicator will be updated to match the last message in the result set If the result set is empty, there are (currently) no more records in the direction being retrieved. If SortDirection = Desc and there are no more records, you've reached the beginning of the conversation

Get the Conversation List entry for the specified conversation in the village

Send a message in a specified conversation or to a specified user or to the village's default conversation. Specify ConversationId OR TargetUserId OR neither of them. If ConversationId is specified, TargetUserId is ignored.

Archive a conversation

Restore a conversation

Update the user's Last Read indicator for the conversation

Returns the number of new messages per village

Creates a group conversation in a village

Add one or more members to an existing Group conversation

Change the title/subject of a group conversation

Get a list of current members in a conversation

Get all documents

Returns a list of deleted document IDs

Download the specified document

Delete the specified document

Returns a pre-sorted list of document categories

Returns a list of content types

Upload a document. This method MUST be called with multipart/form-data encoding for the file.<br><br> The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "file": <ul> <li>Content-Disposition: form-data; name="file"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Update a document. If the existing file is being replaced, this method MUST be called with multipart/form-data encoding for the file<br><br> If the existing file is being replaced, the request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "file": <ul> <li>Content-Disposition: form-data; name="file"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Get all links

Returns a list of deleted document IDs

Delete the specified document

Create a link.

Update a link.

Returns a list of document folders for the village

Create a new document folder for the village

Update (e.g. rename) a document folder in a village

Delete a document folder in a village

Create a new event

Edit an existing event

Cancel an event instance / deletes an event

Returns a list of deleted event IDs

Get events matching specified criteria

Get a specific event

Download the specified attachment

Exports events matching specified criteria to PDF document

Add a comment to a event

Delete a comment from an event

Adds the specified users to the existing event assignment

Backwards Compatability Only - Adds the specified users to the existing event assignment

Edit an event comment

Upload an attachment. This method MUST be called with multipart/form-data encoding for the file. The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "file": Content-Disposition: form-data; name="file"; filename="whatever-you-want"Content-Type: mime/type

Delete the specified attachment

Invite one or more villagers to the specified village

Cancel an invitation

Resend an invitation

Get the details of an invitation based on its invitation code

Get a list of the user's invitations

Accept an invitation

Reject an invitation

Get a list of pending invitations for the specified village

Check for an invitation for the current user for a village named 'name'

Gets the latest wellness check

Get all journal entries

Provide a new journal entry for the village

Update an existing journal entry for the village

Get Wellness Trends

Download the photo for a photo journal entry

Delete a journal entry

Delete the specified attachment

Returns a list of deleted journal entry IDs

Add a comment to a journal entry

Edit a comment on a journal entry

Delete a comment on a journal entry

Like a journal entry

Remove like on a journal entry

Like a journal entry comment

Remove like on a journal entry comment

Upload an attachment. This method MUST be called with multipart/form-data encoding for the file. The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "file": Content-Disposition: form-data; name="file"; filename="whatever-you-want"Content-Type: mime/type

Download the specified attachment

Sign In using external token authentication

Initiate Password Recovery email

Reset password using an emailed code

Re-send email address confirmation email

Confirm user's email address (account creation) or pending email (email address change)

Retrieve an SSO Token for passing to the Web

Sign In using password authentication

Log the user out. Deletes the sign in cookie

Returns a set of configuration values suitable for client consumption

Returns a list of countries and their associated states

Return a list of journal entry Moods

Get all conditions available for selection

Get all conditions available for selection

Returns a pre-sorted list of link categories

Get all medications

Download the pill photo for the specified medication

Download the label photo for the specified medication

Delete the specified medication

Add a medication. If photos are included, this method MUST be called with multipart/form-data encoding for the file.<br><br> The request payload for the image MAY include a pill photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "pillphoto": <ul> <li>Content-Disposition: form-data; name="pillphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul> The request payload for the image MAY include a label photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "labelphoto": <ul> <li>Content-Disposition: form-data; name="labelphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Update a medication. If the existing photos are being replaced, this method MUST be called with multipart/form-data encoding for the file<br><br> The request payload for the image MAY include a pill photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "pillphoto": <ul> <li>Content-Disposition: form-data; name="pillphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul> The request payload for the image MAY include a label photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "labelphoto": <ul> <li>Content-Disposition: form-data; name="labelphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Update medication photos. This method MUST be called with multipart/form-data encoding for the file<br><br> The request payload for the image MAY include a pill photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "pillphoto": <ul> <li>Content-Disposition: form-data; name="pillphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul> The request payload for the image MAY include a label photo, which MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "labelphoto": <ul> <li>Content-Disposition: form-data; name="labelphoto"; filename="whatever-you-want"</li> <li>Content-Type: mime/type</li> </ul>

Log a medication as taken

Unlog a medication as taken

Get a list of roles

OBSOLETE: Get a list of villagers for the specified village This method has been replaced by the 'GET Members' API call in this section, and the 'GET Invitations' API call in the Invitation section

Get a list of villagers for the specified village

Change a villager's role within the selected village

Delete a member from a village (also Leave a village, if memberId == current user)

Ping the API

Return API version information

Null method

Get a dictionary of preference definitions (name, value, title, etc.)

Get a list of preference definitions (name, value, title, etc.)

Updates the current user's preferences for the specified village

Resets the current user's preferences for the specified village to the system defaults

Get user marketing preferences

Get the current user's preferences

Set user marketing preference

Change the current user's email address. Email address change requires followup confirmation via link sent to new email address

Cancel a pending email change for the user. Has no effect if the user does not have a pending email address change

Retrieve the current user's profile

Update the current user's profile

Get RBAC settings for village

Update RBAC settings for village

SignUp using an external login source (Google, facebook, etc.)

Sign Up using an email address and password

Get a list of resources available for the specified village, optionally filtered by Condition IDs

Create customer session

No documentation available.

No documentation available.

Create customer

Search customer

Stripe Webhook

Get list of subscription plans

Get user's subscription history

Downgrade subscription by identifying villages and villagers to keep. Any village not in the villages list will be cancelled. Any villager not in the villagers list for a village will be Revoked.

Get details of user's current subscription

Create a new task

Edit an existing task

Get tasks matching specified criteria

Get a specific task

Download the specified attachment

Add a comment to a task

Delete a comment from an task

Returns a list of deleted Task IDs

Adds the specified users to the existing task assignment

Backwards Compatability Only - Adds the specified users to the existing task assignment

Mark a task as completed

Edit a task comment

Delete a task

Delete the specified attachment

Upload an attachment. This method MUST be called with multipart/form-data encoding for the file. The request payload for the image MUST have Content-Disposition and Content-Type headers. The 'name' in the Content-Disposition header MUST be "file": Content-Disposition: form-data; name="file"; filename="whatever-you-want"Content-Type: mime/type

Get list of users who can become the owner.

Get the current ownership transfer request for the specified village (if any)

Get all ownership transfer requests targetting the current user

Submit an ownership transfer request to the specified user

Re-send the current village transfer request

Cancel the current village transfer request

Respond to village ownership transfer request

Get Village Builder status for the specified village (includes user setup tasks)

Mark a village builder step as skipped

Mark a village builder step as completed

Dismiss the village builder (marks all steps as skipped)

Edit a village

Get a specific village the user is a member of

Returns a list of deleted village data IDs

[OBSOLETE] Get a list of roles. Replaced by similar call in Members section. Currently returns HTTP 301 moved permanently.

Get village summary data for removal dialog

Remove (Delete) Village

Create a Village

Get a list of all villages the user is a member of

Get Walkthrough steps for the current village

Download the walkthrough image for the specified walkthrough step

Gets the status indicator for whether the walkthrough has been completed for the current user (USER walkthrough, not Village setup)

Sets (or clears) the status indicator for walkthrough completion for the current user (USER walkthrough, not Village setup)

Get the weather forecast for the village

Gets the latest wellness check

Get all wellness checks

Provide a new wellness check for the village

Get What's New for the current user

Update the user's What's New Viewed date

Download the image for the specified "What's New"