Exelement SyncCloud

Bulk Exports

• Create Export Job - New Leads: Creates an export job for leads created since the last run.
• Create Export Job - New Activities: Creates an export job for activities created since the last run.
• Get Export File: Retrieves a completed export file's content.
• Create Export Job - Leads: Creates a lead export job.
• List Export Jobs: Returns a list of export jobs created in the past 7 days.
• Cancel Export Job: Cancels an export job.
• Create Export Job - Activities: Creates an activity export job.
• Enqueue Export Job: Adds an export job to the processing queue.
• Get Export Job Status: Retrieves the status for an export job.

Leads

• List Updated Leads: Lists leads updated since last run.
• List Leads By Email Address: Gets all of the leads with the specified email address.
• List Leads: Lists all leads using a filter.
• Create Or Update Lead: Creates or updates a lead.
• List Updated Lead Activities: Lists the lead activities updated since the specified date.
• Get Lead: Gets a lead.
• List Lead Activities: Lists a leads activities.
• List Lead Fields: Returns a list of all fields available for interaction via the REST API.
• List Lead Memberships: Lists a leads memberships.
• List Lead Website And Email History: Lists a leads website and email history.
• List Smart Campaigns: Lists the smart campaigns of a lead.

Static Lists

• List Lists: Lists all the static lists.
• Get List: Gets a static list.
• Add Lead To List: Adds a lead or leads to a static list.
• Remove Lead From List : Removes a lead or leads from a static list
• Get List Members: Gets the members of a Static List.

Bulk Imports

• Get Import Job Warnings: Retrieves a list of warnings for an import job.
• Create Import Job: Creates an import job for a csv payload into the target instance.
• Get Import Job Status: Retrieves the status for an import job.
• Get Import Job Failures: Retrieves a list of failures for an import job.

Custom Objects

• List Custom Objects: Lists the API name of existing custom objects.
• Create Custom Objects: Creates a custom object.
• Update Lead Custom Object: Updates a leads custom object. Custom Object mappings must be added as custom fields.
• Create Custom Object Values: Creates a custom objects values. Insert custom object fields under '[input].'.
• Upsert Custom Object Values: Creates or updates a custom objects values. Insert custom object fields under '[input].'.
• Update Custom Object Values: Updates a custom objects values. Insert custom object fields under '[input].'.
• List Linkable Custom Objects: Lists linkable custom objects and their fields.

Activities

• List Activity Types: Lists activity types.

Users

• List Users: Retrieve a list of all user records. Required Permissions: Access User Management Api and Access Users

Subscriptions

• Update Subscription: Upgrade/downgrade an existing subscription.
• Churn Subscription: Churn a subscription.
• Un-churn Subscription: Remove the churn event associated with a subscription. This rewrites history for the subscription, making it appear as thought the subscription never churned to begin with. You may do this for a subscription that has already churned, or that is set to churn in the future.
• Create Subscription: Create a new subscription. Can be for a new user, or a user who already has another subscription.

Users

• Get User's Subscription History: Get the history of subscription updates you've made to a user.
• Update User: Update a User's email address.
• Delete User: Completely delete a user and his subscription history.

Plans

• Get Plan: Retrieve a single manually-added plan by ID
• Update Plan: Retrieve a single manually-added plan by ID
• List Plans: List all manually-added plans.
• Create Plan: Create a new, manually-added plan. You may create a new plan using this endpoint. Alternatively, if you create a manually-added subscription and place that subscription on a plan that has never been referenced before, that plan will automatically be created. If you try to create a plan that already exists, this endpoint will return an error.

Metrics

• Get Monthly Metrics: Retrieve all monthly financial metrics for your company. Optionally scope to an individual metric and/or plan. See https://profitwellapiv2.docs.apiary.io/#reference/metrics/monthly-metrics/get-monthly-metrics for metrics to filter by.
• Get Daily Metrics: Retrieve financial metrics broken down by day for either the current month or the last. Optionally scope to an individual metric and/or plan. See https://profitwellapiv2.docs.apiary.io/#reference/metrics/daily-metrics/get-daily-metrics for metrics to filter by.
• List Plan IDs: Retrieve your company's active plan IDs, sorted by MRR. Will only return plan IDs for which there are currently active customers, and will return at most 150.
• Exclude Customer from Metrics: Exclude user's data from the calculation of all metrics.

Maintenance

• Get API Status: This endpoint returns a status code of 200 if the API is operational and if you've properly authenticated. If you haven't authenticated properly, the endpoint returns a status code of 401.

Company

• Get Company Account Settings: Get your company's ProfitWell account settings. These include your company ID, name, timezone, and the currency in which your metrics are displayed.