Quick Start Guide

API Basics

API Resources

API: Partner Users

Partner Users are the people within your organization that need access to the CleverFox Backup website. Partner Users have access to all associated companies, devices, jobs, and logs. Partner Users also have access to special Partner Only data.

  • Only an Account Owner can modify the Partner Information or add/delete Partner Users.
  • CleverFox Backup will send an invite email with a special account setup link when a Partner User is created.

Attributes

All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.

Name Type Notes
PartnerUserId Integer Read Only
PartnerId Integer Required on POST, otherwise Read Only
Partner Object See API Partners
FirstName String 25 Required
LastName String 25 Required
Email String 256 Required
HomePhone String 20
MobilePhone String 20
WorkPhone String 20
IsAccountOwner Boolean Read Only
IsInactive Boolean
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention

List (GET)

Returns an array of Partner Users in descending order.

URL
https://cleverfoxbackup.com/api/partnerusers
Optional Parameters
  • PageNo: the page number to return, defaults to 1.
  • PageSize: the maximum number of records per page, defaults to 25.
Response Codes
  • 200 OK
Sample JSON 
{
  "data": [
    {
      "PartnerUserId": 1,
      "PartnerId": 1,
      "Partner": {
        "PartnerId": 1,
        "PlanTypeId": 1,
        "PlanType": null,
        "Name": "Forward Thinking Software, LLC",
        "ApplicationId": null,
        "IsInactive": false,
        "AddedOn": "2015-01-01T00:00:00.000",
        "UpdatedOn": null,
        "Token": null
      },
      "FirstName": "Frank",
      "LastName": "Perez",
      "Email": "support@cleverfoxbackup.com",
      "HomePhone": null,
      "MobilePhone": null,
      "WorkPhone": null,
      "IsAccountOwner": true,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Partner User.

URL
https://cleverfoxbackup.com/api/partnerusers/{PartnerUserId}
Required Parameters
  • PartnerUserId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "PartnerUserId": 1,
    "PartnerId": 1,
    "Partner": {
      "PartnerId": 1,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "Forward Thinking Software, LLC",
      "ApplicationId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "FirstName": "Frank",
    "LastName": "Perez",
    "Email": "support@cleverfoxbackup.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsAccountOwner": true,
    "IsInactive": false,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null,
    "Token": null
  }
}

Create (POST)

Creates a Partner User and returns the updated data.

URL
https://cleverfoxbackup.com/api/partnerusers
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "PartnerId": 1,
    "FirstName": "Frank",
    "LastName": "Perez",
    "Email": "support@cleverfoxbackup.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsAccountOwner": true,
    "IsInactive": false,
    "Token": null
  }
}

Update (PUT)

Updates a Partner User and returns the updated data.

URL
https://cleverfoxbackup.com/api/partnerusers/{PartnerUserId}
Required Parameters
  • PartnerUserId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "FirstName": "Frank",
    "LastName": "Perez",
    "Email": "support@cleverfoxbackup.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsInactive": false,
    "Token": null
  }
}

Delete (DELETE)

Deletes a Partner User.

URL
https://cleverfoxbackup.com/api/partnerusers/{PartnerUserId}
Required Parameters
  • PartnerUserId
Response Codes
  • 204 No Content
  • 404 Not Found