Example

The example integration is a mock integration built to provide some examples on usage.

List all Leads

Endpoint

Method URI Headers
GET /api/v1/integrations/example/leads {"Authorization": "Bearer {access_token}"}

{success} Success Response

Code: 200

Content

{
  "data"    : [
    {
      "id": "73064d0a-243f-4aac-ac8d-e16b4d236032",
      "type": "lead",
      "attributes": {
        "name": "Joesph Oreil",
        "email": "joesph.oreil@fake.com"
      }
    },
    {
      "id": "0890d008-c033-4a0a-a0cc-4eb1074fdc9a",
      "type": "lead",
      "attributes": {
        "name": "Morgan D Fontaine",
        "email": "dedric2013@fake.com"
      }
    }
  ]
}

Store a Lead

Endpoint

Method URI Headers
POST /api/v1/integrations/example/leads {"Authorization": "Bearer {access_token}"}

Required Credentials

{
  "secret": "secret"
}

Data Params

{
    "data"    : "lead object"
}

{success} Success Response

Code: 200

Content

{
  "data"    : {
    "id": "0890d008-c033-4a0a-a0cc-4eb1074fdc9a",
    "type": "lead",
    "attributes": {
      "name": "Test A. Test",
      "email": "test@fake.com"
    }
  }
}

Display a Lead

Endpoint

Method URI Headers
GET /api/v1/integrations/example/leads/{leadId} {"Authorization": "Bearer {access_token}"}

{success} Success Response

Code: 200

Content

{
  "data"    : {
    "id": "0890d008-c033-4a0a-a0cc-4eb1074fdc9a",
    "type": "lead",
    "attributes": {
      "name": "Test A. Test",
      "email": "test@fake.com"
    }
  }
}