Jumplead API v2 API Reference

Welcome to the Jumplead API v2 Documentation.

The Jumplead v2 API is a json:api compliant API. Meaning you can use any json:api compatible client to interact with the Jumplead API.

API Endpoint
https://api.jumplead.com/v2
Terms of Service: https://jumplead.com/terms
Contact: support@jumplead.com
Request Content-Types: application/vnd.api+json
Response Content-Types: application/vnd.api+json
Schemes: https
Version: 1.8.0

Authentication

The Jumplead API uses Personal access tokens (API Keys) for authentication. You will find your personal access tokens in your Account Settings.

Once you have your api key it'll need to be included in the X-Jumplead-Auth header for all requests.

Inclusions

To include address and tasks relations of contacts:

https://api.jumplead.com/v2/contacts?include=address,tasks

To include tasks, tasks.reminder and address relations of contacts:

https://api.jumplead.com/v2/contacts?include=tasks.reminder,address

Filtering

To only show contacts where the lastName attribute is exactly Doe:

https://api.jumplead.com/v2/contacts?filter[lastName]=Doe

To only show contacts where the lastName attribute is before M alphabetically:

https://api.jumplead.com/v2/contacts?filter[lastName]=

To only show contacts where the lastName attribute is after M alphabetically:

https://api.jumplead.com/v2/contacts?filter[lastName]=>M

To only show contacts where the lastName attribute is a case-insensitive match against doe:

https://api.jumplead.com/v2/contacts?filter[lastName]=~doe

To only show contacts where the lastName attribute contains for:

https://api.jumplead.com/v2/contacts?filter[lastName]=:for

Fields

To only bring back contacts lastName and email fields:

https://app.jumplead.com/v2/contacts?fields[contacts]=lastName,email

To only bring back contacts lastName and email fields, and company name field:

https://app.jumplead.com/v2/contacts?include=company&fields[contacts]=lastName,email&fields[companies]=name

Sorting

To sort contacts DESC by lastName:

https://app.jumplead.com/v2/contacts?sort=-lastName

To sort contacts ASC by lastName:

https://app.jumplead.com/v2/contacts?sort=lastName

Pagination

Use page[limit]=50 to limit the number of resources in a search request to 50.

Use page[offset]=10 to chose which resulting resource should start the result set.

To fetch resources 100-149: https://app.jumplead.com/v2/contacts?page[offset]=100&page[limit]=50

Activities

Items of activity are used to build up a Contact's Activity stream. There are a number of different type of activity. This endpoint is simply a link to the other activity types.

GET /activities

Search for activities

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activities search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activities",
    "first": "/v2/activities?page%5Boffset%5D=0",
    "prev": "/v2/activities?page%5Boffset%5D==50",
    "last": "/v2/activities?page%5Boffset%5D=250",
    "next": "/v2/activities?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activities",
      "attributes": {
        "activityType": 1,
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activities/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activities/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activities/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "activityTypeData": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/activityTypeData",
            "related": "/v2/activities/5982e37a72ef3634008b49d8/activityTypeData"
          },
          "data": {
            "type": "activityTypeAutomations",
            "id": "5982e37a72ef3634008b49d8"
          }
        }
      },
      "links": {
        "self": "/v2/activities/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activities/{id}

Get a specific instance of activities

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activities find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activities/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activities",
    "attributes": {
      "activityType": 1,
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activities/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activities/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activities/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "activityTypeData": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activities/5982e37a72ef3634008b49d8/relationships/activityTypeData",
          "related": "/v2/activities/5982e37a72ef3634008b49d8/activityTypeData"
        },
        "data": {
          "type": "activityTypeAutomations",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/activities/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Events

Generic activity items. These are items with a simple string body.

GET /activityTypeEvents

Search for activityTypeEvents

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Events search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeEvents",
    "first": "/v2/activityTypeEvents?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeEvents?page%5Boffset%5D==50",
    "last": "/v2/activityTypeEvents?page%5Boffset%5D=250",
    "next": "/v2/activityTypeEvents?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeEvents",
      "attributes": {
        "body": "Triggered Automation: Contact Form",
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeEvents/{id}

Get a specific instance of activityTypeEvents

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Events find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeEvents",
    "attributes": {
      "body": "Triggered Automation: Contact Form",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeEvents/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Forms

Activity releating to Conversion form submits.

GET /activityTypeForms

Search for activityTypeForms

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Forms search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeForms",
    "first": "/v2/activityTypeForms?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeForms?page%5Boffset%5D==50",
    "last": "/v2/activityTypeForms?page%5Boffset%5D=250",
    "next": "/v2/activityTypeForms?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeForms",
      "attributes": {
        "body": "Can I schedule a demo?",
        "subject": "Demo Request Form",
        "fields": [
          {
            "field": "Name",
            "value": "Adam Curtis"
          }
        ],
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeForms/{id}

Get a specific instance of activityTypeForms

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Forms find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeForms",
    "attributes": {
      "body": "Can I schedule a demo?",
      "subject": "Demo Request Form",
      "fields": [
        {
          "field": "Name",
          "value": "Adam Curtis"
        }
      ],
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeForms/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeForms/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Visits

Activity releating to website visit activity. This type of activity links directly to a Prospect/Visitor.

GET /activityTypeVisits

Search for activityTypeVisits

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Visits search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeVisits",
    "first": "/v2/activityTypeVisits?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeVisits?page%5Boffset%5D==50",
    "last": "/v2/activityTypeVisits?page%5Boffset%5D=250",
    "next": "/v2/activityTypeVisits?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeVisits",
      "attributes": {
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospect": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/prospect",
            "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/prospect"
          },
          "data": {
            "type": "prospects",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeVisits/{id}

Get a specific instance of activityTypeVisits

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Visits find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeVisits",
    "attributes": {
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospect": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/prospect",
          "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/prospect"
        },
        "data": {
          "type": "prospects",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeVisits/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Notes

Activity releating to custom notes left against the contact.

GET /activityTypeNotes

Search for activityTypeNotes

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Notes search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeNotes",
    "first": "/v2/activityTypeNotes?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeNotes?page%5Boffset%5D==50",
    "last": "/v2/activityTypeNotes?page%5Boffset%5D=250",
    "next": "/v2/activityTypeNotes?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeNotes",
      "attributes": {
        "body": "We sourced this contact at a trade show.",
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "user": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
            "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /activityTypeNotes

Create a new instance of activityTypeNotes

New or partial resource

data: activityTypeNotes
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeNotes",
    "attributes": {
      "body": "We sourced this contact at a trade show.",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Activity Type Notes create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeNotes",
    "first": "/v2/activityTypeNotes?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeNotes?page%5Boffset%5D==50",
    "last": "/v2/activityTypeNotes?page%5Boffset%5D=250",
    "next": "/v2/activityTypeNotes?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeNotes",
    "attributes": {
      "body": "We sourced this contact at a trade show.",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeNotes/{id}

Get a specific instance of activityTypeNotes

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Notes find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeNotes",
    "attributes": {
      "body": "We sourced this contact at a trade show.",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /activityTypeNotes/{id}

Delete an instance of activityTypeNotes

id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Notes delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /activityTypeNotes/{id}

Update an instance of activityTypeNotes

New or partial resource

data: activityTypeNotes
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeNotes",
    "attributes": {
      "body": "We sourced this contact at a trade show.",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Activity Type Notes update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeNotes",
    "attributes": {
      "body": "We sourced this contact at a trade show.",
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/user",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeNotes/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Subscriptions

Activity releating to a contact's subscription to a Autoresponder. Campaigns aren't currenly available in the v2 API, please use v1 to get details of a particular campaign.

GET /activityTypeSubscriptions

Search for activityTypeSubscriptions

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Subscriptions search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeSubscriptions",
    "first": "/v2/activityTypeSubscriptions?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeSubscriptions?page%5Boffset%5D==50",
    "last": "/v2/activityTypeSubscriptions?page%5Boffset%5D=250",
    "next": "/v2/activityTypeSubscriptions?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeSubscriptions",
      "attributes": {
        "campaign": "5087d89a567e290c02000000",
        "subscribed": false,
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeSubscriptions/{id}

Get a specific instance of activityTypeSubscriptions

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Subscriptions find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeSubscriptions",
    "attributes": {
      "campaign": "5087d89a567e290c02000000",
      "subscribed": false,
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeSubscriptions/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Opt In Outs

If a contact opts out of a particular campaign this activity records that event.

GET /activityTypeOptInOuts

Search for activityTypeOptInOuts

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Opt In Outs search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeOptInOuts",
    "first": "/v2/activityTypeOptInOuts?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeOptInOuts?page%5Boffset%5D==50",
    "last": "/v2/activityTypeOptInOuts?page%5Boffset%5D=250",
    "next": "/v2/activityTypeOptInOuts?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeOptInOuts",
      "attributes": {
        "campaign": "5087d89a567e290c02000000",
        "campaignEmail": "598accbd0d8f19ef00000001",
        "subscribed": false,
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeOptInOuts/{id}

Get a specific instance of activityTypeOptInOuts

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Opt In Outs find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeOptInOuts",
    "attributes": {
      "campaign": "5087d89a567e290c02000000",
      "campaignEmail": "598accbd0d8f19ef00000001",
      "subscribed": false,
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeOptInOuts/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Email Events

Activity releating to a activity of a particular email to a contact. Includes email activity such as clicks, delivers and opens.

GET /activityTypeEmailEvents

Search for activityTypeEmailEvents

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Email Events search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeEmailEvents",
    "first": "/v2/activityTypeEmailEvents?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeEmailEvents?page%5Boffset%5D==50",
    "last": "/v2/activityTypeEmailEvents?page%5Boffset%5D=250",
    "next": "/v2/activityTypeEmailEvents?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeEmailEvents",
      "attributes": {
        "campaign": "5087d89a567e290c02000000",
        "campaignEmail": "598accbd0d8f19ef00000001",
        "createdDate": "2017-08-03T08:48:58.247Z",
        "rejectDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "unsubDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "spamreportDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "deferredDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "bounceEmails": [
          "foo@bar.com"
        ],
        "bounceDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "clickUrls": [
          "http://google.com"
        ],
        "clickDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "openDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "deliveredDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ]
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeEmailEvents/{id}

Get a specific instance of activityTypeEmailEvents

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Email Events find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeEmailEvents",
    "attributes": {
      "campaign": "5087d89a567e290c02000000",
      "campaignEmail": "598accbd0d8f19ef00000001",
      "createdDate": "2017-08-03T08:48:58.247Z",
      "rejectDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "unsubDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "spamreportDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "deferredDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "bounceEmails": [
        "foo@bar.com"
      ],
      "bounceDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "clickUrls": [
        "http://google.com"
      ],
      "clickDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "openDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "deliveredDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ]
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeEmailEvents/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Personal Emails

Activity within this endpoint has been deprecated. It contains legacy personal emails.

GET /activityTypePersonalEmails

Search for activityTypePersonalEmails

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Personal Emails search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypePersonalEmails",
    "first": "/v2/activityTypePersonalEmails?page%5Boffset%5D=0",
    "prev": "/v2/activityTypePersonalEmails?page%5Boffset%5D==50",
    "last": "/v2/activityTypePersonalEmails?page%5Boffset%5D=250",
    "next": "/v2/activityTypePersonalEmails?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypePersonalEmails",
      "attributes": {
        "body": "<p>What time would you like your demo?</p><p>Thanks Adam</p>",
        "subject": "Demo Request",
        "fromName": "Adam Curtis",
        "fromEmail": "adam@jumplead.com",
        "createdDate": "2017-08-03T08:48:58.247Z",
        "rejectDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "unsubDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "spamreportDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "deferredDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "bounceEmails": [
          "foo@bar.com"
        ],
        "bounceDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "clickUrls": [
          "http://google.com"
        ],
        "clickDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "openDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ],
        "deliveredDates": [
          "2017-08-03T08:48:58.247Z",
          "2015-01-03T04:34:12.154Z"
        ]
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypePersonalEmails/{id}

Get a specific instance of activityTypePersonalEmails

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Personal Emails find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypePersonalEmails",
    "attributes": {
      "body": "<p>What time would you like your demo?</p><p>Thanks Adam</p>",
      "subject": "Demo Request",
      "fromName": "Adam Curtis",
      "fromEmail": "adam@jumplead.com",
      "createdDate": "2017-08-03T08:48:58.247Z",
      "rejectDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "unsubDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "spamreportDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "deferredDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "bounceEmails": [
        "foo@bar.com"
      ],
      "bounceDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "clickUrls": [
        "http://google.com"
      ],
      "clickDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "openDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ],
      "deliveredDates": [
        "2017-08-03T08:48:58.247Z",
        "2015-01-03T04:34:12.154Z"
      ]
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypePersonalEmails/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type System Alerts

This type of activity contains system messages from Jumplead. Currently only invalid phone numbers are recorded.

GET /activityTypeSystemAlerts

Search for activityTypeSystemAlerts

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type System Alerts search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeSystemAlerts",
    "first": "/v2/activityTypeSystemAlerts?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeSystemAlerts?page%5Boffset%5D==50",
    "last": "/v2/activityTypeSystemAlerts?page%5Boffset%5D=250",
    "next": "/v2/activityTypeSystemAlerts?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeSystemAlerts",
      "attributes": {
        "translation": "contactInvalidNumber",
        "alertData": {
          "number": "123456"
        },
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeSystemAlerts/{id}

Get a specific instance of activityTypeSystemAlerts

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type System Alerts find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeSystemAlerts",
    "attributes": {
      "translation": "contactInvalidNumber",
      "alertData": {
        "number": "123456"
      },
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeSystemAlerts/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Activity Type Automations

Activity releating to a automations triggered by a contact.

GET /activityTypeAutomations

Search for activityTypeAutomations

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Activity Type Automations search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/activityTypeAutomations",
    "first": "/v2/activityTypeAutomations?page%5Boffset%5D=0",
    "prev": "/v2/activityTypeAutomations?page%5Boffset%5D==50",
    "last": "/v2/activityTypeAutomations?page%5Boffset%5D=250",
    "next": "/v2/activityTypeAutomations?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "activityTypeAutomations",
      "attributes": {
        "createdDate": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "automation": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/automation",
            "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/automation"
          },
          "data": {
            "type": "automations",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "prospectCompany": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/prospectCompany",
            "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/prospectCompany"
          },
          "data": {
            "type": "prospectCompanies",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /activityTypeAutomations/{id}

Get a specific instance of activityTypeAutomations

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Activity Type Automations find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "activityTypeAutomations",
    "attributes": {
      "createdDate": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "automation": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/automation",
          "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/automation"
        },
        "data": {
          "type": "automations",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "prospectCompany": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/prospectCompany",
          "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/prospectCompany"
        },
        "data": {
          "type": "prospectCompanies",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/activityTypeAutomations/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Analytics Campaigns

Analytics Campaigns maintain emails campaigns and prospects who clicked a link that contains UTM tags.

GET /analyticsCampaigns

Search for analyticsCampaigns

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Analytics Campaigns search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/analyticsCampaigns",
    "first": "/v2/analyticsCampaigns?page%5Boffset%5D=0",
    "prev": "/v2/analyticsCampaigns?page%5Boffset%5D==50",
    "last": "/v2/analyticsCampaigns?page%5Boffset%5D=250",
    "next": "/v2/analyticsCampaigns?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "analyticsCampaigns",
      "attributes": {
        "name": "Social Media Campaign",
        "medium": "Email",
        "source": "facebook",
        "term": "jumplead",
        "content": "Social media"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /analyticsCampaigns/{id}

Get a specific instance of analyticsCampaigns

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Analytics Campaigns find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "analyticsCampaigns",
    "attributes": {
      "name": "Social Media Campaign",
      "medium": "Email",
      "source": "facebook",
      "term": "jumplead",
      "content": "Social media"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/analyticsCampaigns/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Automation Triggers

Automation triggers are recorded when a contact triggers an automation.

GET /automationTriggers

Search for automationTriggers

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Automation Triggers search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/automationTriggers",
    "first": "/v2/automationTriggers?page%5Boffset%5D=0",
    "prev": "/v2/automationTriggers?page%5Boffset%5D==50",
    "last": "/v2/automationTriggers?page%5Boffset%5D=250",
    "next": "/v2/automationTriggers?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "automationTriggers",
      "attributes": {
        "date": "2017-08-09T00:00:00.000Z",
        "lastUpdated": "2017-08-09T17:08:50.415Z"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        },
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "automation": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/automation",
            "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/automation"
          },
          "data": {
            "type": "automations",
            "id": "5982e37a72ef3634008b49d8"
          }
        }
      },
      "links": {
        "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /automationTriggers/{id}

Get a specific instance of automationTriggers

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Automation Triggers find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automationTriggers",
    "attributes": {
      "date": "2017-08-09T00:00:00.000Z",
      "lastUpdated": "2017-08-09T17:08:50.415Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "automation": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8/relationships/automation",
          "related": "/v2/automationTriggers/5982e37a72ef3634008b49d8/automation"
        },
        "data": {
          "type": "automations",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/automationTriggers/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Automations

Automations handle certain automation tags such as add a tag to a contact or subscribing them to a campaign.

WARNING: This endpoint is currently incomplete and requires a very specific format. We don't recommend creating or editing automations through the API at this time.

GET /automations

Search for automations

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Automations search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/automations",
    "first": "/v2/automations?page%5Boffset%5D=0",
    "prev": "/v2/automations?page%5Boffset%5D==50",
    "last": "/v2/automations?page%5Boffset%5D=250",
    "next": "/v2/automations?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "automations",
      "attributes": {
        "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
        "name": "Notification",
        "description": "Send a notification to a user.",
        "triggerType": "form",
        "triggerId": "596612f86501fd5102000001",
        "stats": "{}"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/automations/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /automations

Create a new instance of automations

New or partial resource

data: automations
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automations",
    "attributes": {
      "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
      "name": "Notification",
      "description": "Send a notification to a user.",
      "triggerType": "form",
      "triggerId": "596612f86501fd5102000001",
      "stats": "{}"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/automations/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Automations create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/automations",
    "first": "/v2/automations?page%5Boffset%5D=0",
    "prev": "/v2/automations?page%5Boffset%5D==50",
    "last": "/v2/automations?page%5Boffset%5D=250",
    "next": "/v2/automations?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automations",
    "attributes": {
      "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
      "name": "Notification",
      "description": "Send a notification to a user.",
      "triggerType": "form",
      "triggerId": "596612f86501fd5102000001",
      "stats": "{}"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/automations/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /automations/{id}

Get a specific instance of automations

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Automations find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/automations/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automations",
    "attributes": {
      "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
      "name": "Notification",
      "description": "Send a notification to a user.",
      "triggerType": "form",
      "triggerId": "596612f86501fd5102000001",
      "stats": "{}"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/automations/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /automations/{id}

Delete an instance of automations

id

id of specific instance to lookup

type
string
in
path
200 OK

Automations delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/automations/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /automations/{id}

Update an instance of automations

New or partial resource

data: automations
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automations",
    "attributes": {
      "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
      "name": "Notification",
      "description": "Send a notification to a user.",
      "triggerType": "form",
      "triggerId": "596612f86501fd5102000001",
      "stats": "{}"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/automations/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Automations update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/automations/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "automations",
    "attributes": {
      "actions": "[{\"type\":\"notification\",\"users\":[\"1\"]}]",
      "name": "Notification",
      "description": "Send a notification to a user.",
      "triggerType": "form",
      "triggerId": "596612f86501fd5102000001",
      "stats": "{}"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/automations/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/automations/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/automations/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Billing Invoices

View and retrieve Jumplead account invoices

GET /billingInvoices

Search for billingInvoices

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Billing Invoices search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/billingInvoices",
    "first": "/v2/billingInvoices?page%5Boffset%5D=0",
    "prev": "/v2/billingInvoices?page%5Boffset%5D==50",
    "last": "/v2/billingInvoices?page%5Boffset%5D=250",
    "next": "/v2/billingInvoices?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "billingInvoices",
      "attributes": {
        "cost": 49,
        "currency": "USD",
        "reference": "JL-INV-11707019361",
        "createdAt": "2017-07-01T10:00:02.613Z",
        "status": 1,
        "taxRate": 0,
        "credit": 0,
        "items": [
          {
            "description": "Jumplead Pro Account",
            "subtotal": 49,
            "subItems": []
          }
        ],
        "coupon": {
          "code": "CG6C-4F1K-LG3J",
          "percent_off": 20
        }
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/billingInvoices/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/billingInvoices/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/billingInvoices/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /billingInvoices/{id}

Get a specific instance of billingInvoices

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Billing Invoices find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/billingInvoices/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "billingInvoices",
    "attributes": {
      "cost": 49,
      "currency": "USD",
      "reference": "JL-INV-11707019361",
      "createdAt": "2017-07-01T10:00:02.613Z",
      "status": 1,
      "taxRate": 0,
      "credit": 0,
      "items": [
        {
          "description": "Jumplead Pro Account",
          "subtotal": 49,
          "subItems": []
        }
      ],
      "coupon": {
        "code": "CG6C-4F1K-LG3J",
        "percent_off": 20
      }
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/billingInvoices/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/billingInvoices/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/billingInvoices/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Client Addresses

These items are your company registered addresses inside Jumplead.

You can only have 1 billing and company address.

GET /clientAddresses

Search for clientAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Client Addresses search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientAddresses",
    "first": "/v2/clientAddresses?page%5Boffset%5D=0",
    "prev": "/v2/clientAddresses?page%5Boffset%5D==50",
    "last": "/v2/clientAddresses?page%5Boffset%5D=250",
    "next": "/v2/clientAddresses?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "clientAddresses",
      "attributes": {
        "addressStreet": "23 Hallfields Lane",
        "addressLocality": "Rothley",
        "addressAdminArea": "Leicestershire",
        "addressDependentLocality": "string",
        "addressPostalCode": "LE7 7NF",
        "addressSortingCode": "string",
        "addressCountry": "GB",
        "isBillingAddress": true,
        "isCompanyAddress": true
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /clientAddresses

Create a new instance of clientAddresses

New or partial resource

data: clientAddresses
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB",
      "isBillingAddress": true,
      "isCompanyAddress": true
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Client Addresses create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientAddresses",
    "first": "/v2/clientAddresses?page%5Boffset%5D=0",
    "prev": "/v2/clientAddresses?page%5Boffset%5D==50",
    "last": "/v2/clientAddresses?page%5Boffset%5D=250",
    "next": "/v2/clientAddresses?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB",
      "isBillingAddress": true,
      "isCompanyAddress": true
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clientAddresses/{id}

Get a specific instance of clientAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Client Addresses find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB",
      "isBillingAddress": true,
      "isCompanyAddress": true
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /clientAddresses/{id}

Delete an instance of clientAddresses

id

id of specific instance to lookup

type
string
in
path
200 OK

Client Addresses delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /clientAddresses/{id}

Update an instance of clientAddresses

New or partial resource

data: clientAddresses
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB",
      "isBillingAddress": true,
      "isCompanyAddress": true
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Client Addresses update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB",
      "isBillingAddress": true,
      "isCompanyAddress": true
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientAddresses/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Client Ip Blacklists

Manage your account IPv4 addresses in Jumplead that are ignored for tracking.

GET /clientIpBlacklists

Search for clientIpBlacklists

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Client Ip Blacklists search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientIpBlacklists",
    "first": "/v2/clientIpBlacklists?page%5Boffset%5D=0",
    "prev": "/v2/clientIpBlacklists?page%5Boffset%5D==50",
    "last": "/v2/clientIpBlacklists?page%5Boffset%5D=250",
    "next": "/v2/clientIpBlacklists?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "clientIpBlacklists",
      "attributes": {
        "ipAddress": "82.24.123.78"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /clientIpBlacklists

Create a new instance of clientIpBlacklists

New or partial resource

data: clientIpBlacklists
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientIpBlacklists",
    "attributes": {
      "ipAddress": "82.24.123.78"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Client Ip Blacklists create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientIpBlacklists",
    "first": "/v2/clientIpBlacklists?page%5Boffset%5D=0",
    "prev": "/v2/clientIpBlacklists?page%5Boffset%5D==50",
    "last": "/v2/clientIpBlacklists?page%5Boffset%5D=250",
    "next": "/v2/clientIpBlacklists?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientIpBlacklists",
    "attributes": {
      "ipAddress": "82.24.123.78"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clientIpBlacklists/{id}

Get a specific instance of clientIpBlacklists

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Client Ip Blacklists find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientIpBlacklists",
    "attributes": {
      "ipAddress": "82.24.123.78"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /clientIpBlacklists/{id}

Delete an instance of clientIpBlacklists

id

id of specific instance to lookup

type
string
in
path
200 OK

Client Ip Blacklists delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /clientIpBlacklists/{id}

Update an instance of clientIpBlacklists

New or partial resource

data: clientIpBlacklists
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientIpBlacklists",
    "attributes": {
      "ipAddress": "82.24.123.78"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Client Ip Blacklists update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientIpBlacklists",
    "attributes": {
      "ipAddress": "82.24.123.78"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientIpBlacklists/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Client Quotas

View your remaining Jumplead account quotas. Match with your clientId.

GET /clientQuotas

Search for clientQuotas

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Client Quotas search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientQuotas",
    "first": "/v2/clientQuotas?page%5Boffset%5D=0",
    "prev": "/v2/clientQuotas?page%5Boffset%5D==50",
    "last": "/v2/clientQuotas?page%5Boffset%5D=250",
    "next": "/v2/clientQuotas?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "1",
      "type": "clientQuotas",
      "attributes": {
        "visitQuota": 5000,
        "visit": 145,
        "userQuota": 10,
        "user": 3,
        "chatQuota": 20,
        "chat": 0,
        "contactQuota": 50000,
        "contact": 17831,
        "emailQuota": 50000,
        "email": 23910,
        "keywordQuota": 50,
        "keyword": 35
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clientQuotas/1/relationships/client",
            "related": "/v2/clientQuotas/1/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/clientQuotas/1"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clientQuotas/{id}

Get a specific instance of clientQuotas

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Client Quotas find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientQuotas/1"
  },
  "data": {
    "id": "1",
    "type": "clientQuotas",
    "attributes": {
      "visitQuota": 5000,
      "visit": 145,
      "userQuota": 10,
      "user": 3,
      "chatQuota": 20,
      "chat": 0,
      "contactQuota": 50000,
      "contact": 17831,
      "emailQuota": 50000,
      "email": 23910,
      "keywordQuota": 50,
      "keyword": 35
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientQuotas/1/relationships/client",
          "related": "/v2/clientQuotas/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientQuotas/1"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Client Statuses

Client statuses are used to record the status of a Jumplead account

GET /clientStatuses

Search for clientStatuses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Client Statuses search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientStatuses",
    "first": "/v2/clientStatuses?page%5Boffset%5D=0",
    "prev": "/v2/clientStatuses?page%5Boffset%5D==50",
    "last": "/v2/clientStatuses?page%5Boffset%5D=250",
    "next": "/v2/clientStatuses?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "clientStatuses",
      "attributes": {
        "status": "Subscription Active"
      },
      "relationships": {},
      "links": {
        "self": "/v2/clientStatuses/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clientStatuses/{id}

Get a specific instance of clientStatuses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Client Statuses find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientStatuses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "clientStatuses",
    "attributes": {
      "status": "Subscription Active"
    },
    "relationships": {},
    "links": {
      "self": "/v2/clientStatuses/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Client Users

Client users expose the links between clients and users. This is where a user's admin status is managed.

Note: kongConsumerId is for internal use only.

GET /clientUsers

Search for clientUsers

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Client Users search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientUsers",
    "first": "/v2/clientUsers?page%5Boffset%5D=0",
    "prev": "/v2/clientUsers?page%5Boffset%5D==50",
    "last": "/v2/clientUsers?page%5Boffset%5D=250",
    "next": "/v2/clientUsers?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "1",
      "type": "clientUsers",
      "attributes": {
        "admin": false,
        "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clientUsers/1/relationships/client",
            "related": "/v2/clientUsers/1/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        },
        "user": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clientUsers/1/relationships/user",
            "related": "/v2/clientUsers/1/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      },
      "links": {
        "self": "/v2/clientUsers/1"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /clientUsers

Create a new instance of clientUsers

New or partial resource

data: clientUsers
Request Example
{
  "data": {
    "id": "1",
    "type": "clientUsers",
    "attributes": {
      "admin": false,
      "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/client",
          "related": "/v2/clientUsers/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/user",
          "related": "/v2/clientUsers/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientUsers/1"
    }
  }
}
201 Created

Client Users create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clientUsers",
    "first": "/v2/clientUsers?page%5Boffset%5D=0",
    "prev": "/v2/clientUsers?page%5Boffset%5D==50",
    "last": "/v2/clientUsers?page%5Boffset%5D=250",
    "next": "/v2/clientUsers?page%5Boffset%5D=150"
  },
  "data": {
    "id": "1",
    "type": "clientUsers",
    "attributes": {
      "admin": false,
      "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/client",
          "related": "/v2/clientUsers/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/user",
          "related": "/v2/clientUsers/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientUsers/1"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clientUsers/{id}

Get a specific instance of clientUsers

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Client Users find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientUsers/1"
  },
  "data": {
    "id": "1",
    "type": "clientUsers",
    "attributes": {
      "admin": false,
      "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/client",
          "related": "/v2/clientUsers/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/user",
          "related": "/v2/clientUsers/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientUsers/1"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /clientUsers/{id}

Delete an instance of clientUsers

id

id of specific instance to lookup

type
string
in
path
200 OK

Client Users delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientUsers/1"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /clientUsers/{id}

Update an instance of clientUsers

New or partial resource

data: clientUsers
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "1",
    "type": "clientUsers",
    "attributes": {
      "admin": false,
      "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/client",
          "related": "/v2/clientUsers/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/user",
          "related": "/v2/clientUsers/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientUsers/1"
    }
  }
}
200 OK

Client Users update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clientUsers/1"
  },
  "data": {
    "id": "1",
    "type": "clientUsers",
    "attributes": {
      "admin": false,
      "kongConsumerId": "da5ae153-78d9-4057-a73e-e280a79df69d"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/client",
          "related": "/v2/clientUsers/1/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "user": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clientUsers/1/relationships/user",
          "related": "/v2/clientUsers/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/v2/clientUsers/1"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Clients

A Jumplead account is known as a client in the API. Pretty much every item in Jumplead links directly to your client or user.

When creating new items in the Jumplead API its required that you always pass your clientId. If you don't what this is you can find it in the API's meta.session output.

GET /clients

Search for clients

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Clients search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/clients",
    "first": "/v2/clients?page%5Boffset%5D=0",
    "prev": "/v2/clients?page%5Boffset%5D==50",
    "last": "/v2/clients?page%5Boffset%5D=250",
    "next": "/v2/clients?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "1",
      "type": "clients",
      "attributes": {
        "domain": "jumplead.com",
        "status": 1,
        "company": "Jumplead",
        "telephone": "+448451235488",
        "pricingRegion": "UK",
        "campaignStatus": "PROVISIONED",
        "newCustomer": false,
        "chatEnabled": true,
        "conversationTeamName": "Jumplead Team",
        "conversationTeamText": "How can we help you today?",
        "conversationTeamImage": "https://jumplead-team-avatars.s3.amazonaws.com/client-team-1?1500462778",
        "conversationBrand": "#2290BF",
        "esp": "sparkpost",
        "resoldAccount": false,
        "createdDate": "2011-04-27T11:22:01.000Z",
        "trackerId": "JL-1303903321-1"
      },
      "relationships": {
        "users": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clients/1/relationships/users",
            "related": "/v2/clients/1/users"
          },
          "data": [
            {
              "type": "users",
              "id": "1"
            }
          ]
        },
        "quota": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clients/1/relationships/quota",
            "related": "/v2/clients/1/quota"
          },
          "data": {
            "type": "clientQuotas",
            "id": "1"
          }
        },
        "pricing": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clients/1/relationships/pricing",
            "related": "/v2/clients/1/pricing"
          },
          "data": {
            "type": "pricingModels",
            "id": "5982e37a72ef3634008b49d8"
          }
        },
        "addresses": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/clients/1/relationships/addresses",
            "related": "/v2/clients/1/addresses"
          },
          "data": [
            {
              "type": "clientAddresses",
              "id": "5982e37a72ef3634008b49d8"
            }
          ]
        }
      },
      "links": {
        "self": "/v2/clients/1"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /clients/{id}

Get a specific instance of clients

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Clients find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clients/1"
  },
  "data": {
    "id": "1",
    "type": "clients",
    "attributes": {
      "domain": "jumplead.com",
      "status": 1,
      "company": "Jumplead",
      "telephone": "+448451235488",
      "pricingRegion": "UK",
      "campaignStatus": "PROVISIONED",
      "newCustomer": false,
      "chatEnabled": true,
      "conversationTeamName": "Jumplead Team",
      "conversationTeamText": "How can we help you today?",
      "conversationTeamImage": "https://jumplead-team-avatars.s3.amazonaws.com/client-team-1?1500462778",
      "conversationBrand": "#2290BF",
      "esp": "sparkpost",
      "resoldAccount": false,
      "createdDate": "2011-04-27T11:22:01.000Z",
      "trackerId": "JL-1303903321-1"
    },
    "relationships": {
      "users": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/users",
          "related": "/v2/clients/1/users"
        },
        "data": [
          {
            "type": "users",
            "id": "1"
          }
        ]
      },
      "quota": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/quota",
          "related": "/v2/clients/1/quota"
        },
        "data": {
          "type": "clientQuotas",
          "id": "1"
        }
      },
      "pricing": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/pricing",
          "related": "/v2/clients/1/pricing"
        },
        "data": {
          "type": "pricingModels",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "addresses": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/addresses",
          "related": "/v2/clients/1/addresses"
        },
        "data": [
          {
            "type": "clientAddresses",
            "id": "5982e37a72ef3634008b49d8"
          }
        ]
      }
    },
    "links": {
      "self": "/v2/clients/1"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /clients/{id}

Delete an instance of clients

id

id of specific instance to lookup

type
string
in
path
200 OK

Clients delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clients/1"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /clients/{id}

Update an instance of clients

New or partial resource

data: clients
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "1",
    "type": "clients",
    "attributes": {
      "domain": "jumplead.com",
      "status": 1,
      "company": "Jumplead",
      "telephone": "+448451235488",
      "pricingRegion": "UK",
      "campaignStatus": "PROVISIONED",
      "newCustomer": false,
      "chatEnabled": true,
      "conversationTeamName": "Jumplead Team",
      "conversationTeamText": "How can we help you today?",
      "conversationTeamImage": "https://jumplead-team-avatars.s3.amazonaws.com/client-team-1?1500462778",
      "conversationBrand": "#2290BF",
      "esp": "sparkpost",
      "resoldAccount": false,
      "createdDate": "2011-04-27T11:22:01.000Z",
      "trackerId": "JL-1303903321-1"
    },
    "relationships": {
      "users": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/users",
          "related": "/v2/clients/1/users"
        },
        "data": [
          {
            "type": "users",
            "id": "1"
          }
        ]
      },
      "quota": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/quota",
          "related": "/v2/clients/1/quota"
        },
        "data": {
          "type": "clientQuotas",
          "id": "1"
        }
      },
      "pricing": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/pricing",
          "related": "/v2/clients/1/pricing"
        },
        "data": {
          "type": "pricingModels",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "addresses": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/addresses",
          "related": "/v2/clients/1/addresses"
        },
        "data": [
          {
            "type": "clientAddresses",
            "id": "5982e37a72ef3634008b49d8"
          }
        ]
      }
    },
    "links": {
      "self": "/v2/clients/1"
    }
  }
}
200 OK

Clients update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/clients/1"
  },
  "data": {
    "id": "1",
    "type": "clients",
    "attributes": {
      "domain": "jumplead.com",
      "status": 1,
      "company": "Jumplead",
      "telephone": "+448451235488",
      "pricingRegion": "UK",
      "campaignStatus": "PROVISIONED",
      "newCustomer": false,
      "chatEnabled": true,
      "conversationTeamName": "Jumplead Team",
      "conversationTeamText": "How can we help you today?",
      "conversationTeamImage": "https://jumplead-team-avatars.s3.amazonaws.com/client-team-1?1500462778",
      "conversationBrand": "#2290BF",
      "esp": "sparkpost",
      "resoldAccount": false,
      "createdDate": "2011-04-27T11:22:01.000Z",
      "trackerId": "JL-1303903321-1"
    },
    "relationships": {
      "users": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/users",
          "related": "/v2/clients/1/users"
        },
        "data": [
          {
            "type": "users",
            "id": "1"
          }
        ]
      },
      "quota": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/quota",
          "related": "/v2/clients/1/quota"
        },
        "data": {
          "type": "clientQuotas",
          "id": "1"
        }
      },
      "pricing": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/pricing",
          "related": "/v2/clients/1/pricing"
        },
        "data": {
          "type": "pricingModels",
          "id": "5982e37a72ef3634008b49d8"
        }
      },
      "addresses": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/clients/1/relationships/addresses",
          "related": "/v2/clients/1/addresses"
        },
        "data": [
          {
            "type": "clientAddresses",
            "id": "5982e37a72ef3634008b49d8"
          }
        ]
      }
    },
    "links": {
      "self": "/v2/clients/1"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Companies

Companies are associated with your contacts. Use this endpoint to manage data about a contact's company.

GET /companies

Search for companies

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Companies search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/companies",
    "first": "/v2/companies?page%5Boffset%5D=0",
    "prev": "/v2/companies?page%5Boffset%5D==50",
    "last": "/v2/companies?page%5Boffset%5D=250",
    "next": "/v2/companies?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "companies",
      "attributes": {
        "social": [
          {
            "url": "https://www.facebook.com/JumpleadApp/",
            "type": "facebook"
          }
        ],
        "name": "Jumplead",
        "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
        "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
        "tags": [
          "marketing",
          "automation",
          "software"
        ],
        "website": "https://jumplead.com",
        "deletedAt": "2017-08-03T08:48:58.247Z"
      },
      "relationships": {
        "client": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
            "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
          },
          "data": {
            "type": "clients",
            "id": "1"
          }
        },
        "geoname": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
            "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
          },
          "data": {
            "type": "geonames",
            "id": "2639075"
          }
        },
        "address": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
            "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
          },
          "data": {
            "type": "companyAddresses",
            "id": "5982e37a72ef3634008b49d8"
          }
        }
      },
      "links": {
        "self": "/v2/companies/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /companies

Create a new instance of companies

New or partial resource

data: companies
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companies",
    "attributes": {
      "social": [
        {
          "url": "https://www.facebook.com/JumpleadApp/",
          "type": "facebook"
        }
      ],
      "name": "Jumplead",
      "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
      "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
      "tags": [
        "marketing",
        "automation",
        "software"
      ],
      "website": "https://jumplead.com",
      "deletedAt": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "geoname": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
        },
        "data": {
          "type": "geonames",
          "id": "2639075"
        }
      },
      "address": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
        },
        "data": {
          "type": "companyAddresses",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companies/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Companies create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/companies",
    "first": "/v2/companies?page%5Boffset%5D=0",
    "prev": "/v2/companies?page%5Boffset%5D==50",
    "last": "/v2/companies?page%5Boffset%5D=250",
    "next": "/v2/companies?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companies",
    "attributes": {
      "social": [
        {
          "url": "https://www.facebook.com/JumpleadApp/",
          "type": "facebook"
        }
      ],
      "name": "Jumplead",
      "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
      "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
      "tags": [
        "marketing",
        "automation",
        "software"
      ],
      "website": "https://jumplead.com",
      "deletedAt": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "geoname": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
        },
        "data": {
          "type": "geonames",
          "id": "2639075"
        }
      },
      "address": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
        },
        "data": {
          "type": "companyAddresses",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companies/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /companies/{id}

Get a specific instance of companies

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Companies find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/companies/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companies",
    "attributes": {
      "social": [
        {
          "url": "https://www.facebook.com/JumpleadApp/",
          "type": "facebook"
        }
      ],
      "name": "Jumplead",
      "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
      "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
      "tags": [
        "marketing",
        "automation",
        "software"
      ],
      "website": "https://jumplead.com",
      "deletedAt": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "geoname": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
        },
        "data": {
          "type": "geonames",
          "id": "2639075"
        }
      },
      "address": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
        },
        "data": {
          "type": "companyAddresses",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companies/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /companies/{id}

Update an instance of companies

New or partial resource

data: companies
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companies",
    "attributes": {
      "social": [
        {
          "url": "https://www.facebook.com/JumpleadApp/",
          "type": "facebook"
        }
      ],
      "name": "Jumplead",
      "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
      "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
      "tags": [
        "marketing",
        "automation",
        "software"
      ],
      "website": "https://jumplead.com",
      "deletedAt": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "geoname": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
        },
        "data": {
          "type": "geonames",
          "id": "2639075"
        }
      },
      "address": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
        },
        "data": {
          "type": "companyAddresses",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companies/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Companies update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/companies/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companies",
    "attributes": {
      "social": [
        {
          "url": "https://www.facebook.com/JumpleadApp/",
          "type": "facebook"
        }
      ],
      "name": "Jumplead",
      "description": "Turn website visitors into customers with inbound online marketing automation, the best small business internet marketing tools combined.",
      "avatar": "https://jumplead-cdn.s3-eu-west-1.amazonaws.com/logos/5050b85b29487c8745017b32",
      "tags": [
        "marketing",
        "automation",
        "software"
      ],
      "website": "https://jumplead.com",
      "deletedAt": "2017-08-03T08:48:58.247Z"
    },
    "relationships": {
      "client": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/client",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/client"
        },
        "data": {
          "type": "clients",
          "id": "1"
        }
      },
      "geoname": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/geoname",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/geoname"
        },
        "data": {
          "type": "geonames",
          "id": "2639075"
        }
      },
      "address": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companies/5982e37a72ef3634008b49d8/relationships/address",
          "related": "/v2/companies/5982e37a72ef3634008b49d8/address"
        },
        "data": {
          "type": "companyAddresses",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companies/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Company Addresses

These addresses are associated with companies.

GET /companyAddresses

Search for companyAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Company Addresses search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/companyAddresses",
    "first": "/v2/companyAddresses?page%5Boffset%5D=0",
    "prev": "/v2/companyAddresses?page%5Boffset%5D==50",
    "last": "/v2/companyAddresses?page%5Boffset%5D=250",
    "next": "/v2/companyAddresses?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "companyAddresses",
      "attributes": {
        "addressStreet": "23 Hallfields Lane",
        "addressLocality": "Rothley",
        "addressAdminArea": "Leicestershire",
        "addressDependentLocality": "string",
        "addressPostalCode": "LE7 7NF",
        "addressSortingCode": "string",
        "addressCountry": "GB"
      },
      "relationships": {
        "company": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
            "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
          },
          "data": {
            "type": "companies",
            "id": "5982e37a72ef3634008b49d8"
          }
        }
      },
      "links": {
        "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /companyAddresses

Create a new instance of companyAddresses

New or partial resource

data: companyAddresses
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companyAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "company": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
          "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
        },
        "data": {
          "type": "companies",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Company Addresses create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/companyAddresses",
    "first": "/v2/companyAddresses?page%5Boffset%5D=0",
    "prev": "/v2/companyAddresses?page%5Boffset%5D==50",
    "last": "/v2/companyAddresses?page%5Boffset%5D=250",
    "next": "/v2/companyAddresses?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companyAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "company": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
          "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
        },
        "data": {
          "type": "companies",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /companyAddresses/{id}

Get a specific instance of companyAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Company Addresses find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companyAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "company": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
          "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
        },
        "data": {
          "type": "companies",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /companyAddresses/{id}

Delete an instance of companyAddresses

id

id of specific instance to lookup

type
string
in
path
200 OK

Company Addresses delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /companyAddresses/{id}

Update an instance of companyAddresses

New or partial resource

data: companyAddresses
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companyAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "company": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
          "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
        },
        "data": {
          "type": "companies",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
200 OK

Company Addresses update response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "companyAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "company": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8/relationships/company",
          "related": "/v2/companyAddresses/5982e37a72ef3634008b49d8/company"
        },
        "data": {
          "type": "companies",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/companyAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

Contact Addresses

These addresses are associated with contacts.

GET /contactAddresses

Search for contactAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
200 OK

Contact Addresses search response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/contactAddresses",
    "first": "/v2/contactAddresses?page%5Boffset%5D=0",
    "prev": "/v2/contactAddresses?page%5Boffset%5D==50",
    "last": "/v2/contactAddresses?page%5Boffset%5D=250",
    "next": "/v2/contactAddresses?page%5Boffset%5D=150"
  },
  "data": [
    {
      "id": "5982e37a72ef3634008b49d8",
      "type": "contactAddresses",
      "attributes": {
        "addressStreet": "23 Hallfields Lane",
        "addressLocality": "Rothley",
        "addressAdminArea": "Leicestershire",
        "addressDependentLocality": "string",
        "addressPostalCode": "LE7 7NF",
        "addressSortingCode": "string",
        "addressCountry": "GB"
      },
      "relationships": {
        "contact": {
          "meta": {
            "relation": "primary",
            "readOnly": false
          },
          "links": {
            "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8/relationships/contact",
            "related": "/v2/contactAddresses/5982e37a72ef3634008b49d8/contact"
          },
          "data": {
            "type": "contacts",
            "id": "5982e37a72ef3634008b49d8"
          }
        }
      },
      "links": {
        "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
      }
    }
  ],
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

POST /contactAddresses

Create a new instance of contactAddresses

New or partial resource

data: contactAddresses
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "contactAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/contactAddresses/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
201 Created

Contact Addresses create response

default

Unexpected error

Response Example (201 Created)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    },
    "page": {
      "offset": 100,
      "limit": 50,
      "total": 250
    }
  },
  "links": {
    "self": "/v2/contactAddresses",
    "first": "/v2/contactAddresses?page%5Boffset%5D=0",
    "prev": "/v2/contactAddresses?page%5Boffset%5D==50",
    "last": "/v2/contactAddresses?page%5Boffset%5D=250",
    "next": "/v2/contactAddresses?page%5Boffset%5D=150"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "contactAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/contactAddresses/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
    }
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

GET /contactAddresses/{id}

Get a specific instance of contactAddresses

sort

Sort resources as per the JSON:API specification

type
string
in
query
include

Fetch additional resources as per the JSON:API specification

type
string
in
query
filter

Filter resources as per the JSON:API specification

type
string
in
query
fields

Limit response payloads as per the JSON:API specification

type
string
in
query
page

Pagination namespace

type
string
in
query
id

id of specific instance to lookup

type
string
in
path
200 OK

Contact Addresses find response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
  },
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "contactAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/contactAddresses/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      }
    },
    "links": {
      "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
    }
  },
  "included": []
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

DELETE /contactAddresses/{id}

Delete an instance of contactAddresses

id

id of specific instance to lookup

type
string
in
path
200 OK

Contact Addresses delete response

default

Unexpected error

Response Example (200 OK)
{
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "copyright": "Copyright Mooloop Limited.",
    "version": "1.8.0",
    "session": {
      "clientId": 1,
      "userId": 1,
      "timezone": "Europe/London",
      "scopes": []
    }
  },
  "links": {
    "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8"
  }
}
Response Example (default )
{
  "jsonapi": {
    "version": "string"
  },
  "meta": "object",
  "links": {
    "self": "string"
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "object"
    }
  ]
}

PATCH /contactAddresses/{id}

Update an instance of contactAddresses

New or partial resource

data: contactAddresses
id

id of specific instance to lookup

type
string
in
path
Request Example
{
  "data": {
    "id": "5982e37a72ef3634008b49d8",
    "type": "contactAddresses",
    "attributes": {
      "addressStreet": "23 Hallfields Lane",
      "addressLocality": "Rothley",
      "addressAdminArea": "Leicestershire",
      "addressDependentLocality": "string",
      "addressPostalCode": "LE7 7NF",
      "addressSortingCode": "string",
      "addressCountry": "GB"
    },
    "relationships": {
      "contact": {
        "meta": {
          "relation": "primary",
          "readOnly": false
        },
        "links": {
          "self": "/v2/contactAddresses/5982e37a72ef3634008b49d8/relationships/contact",
          "related": "/v2/contactAddresses/5982e37a72ef3634008b49d8/contact"
        },
        "data": {
          "type": "contacts",
          "id": "5982e37a72ef3634008b49d8"
        }
      }