Lists

The list resource represents a list or group record that has been synchronized from one or many of the Mesh integrations.

Provider Mapping


Provider Model URL
Sendgrid account https://sendgrid.com/docs/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html
Mailchimp lists http://developer.mailchimp.com/documentation/mailchimp/reference/lists/
Intercom tag https://developers.intercom.io/reference#tags
Hubspot contact list https://developers.intercom.io/reference#companies

Model


Field Type Description
id string The the Mesh identifier for the list.
created_at int The original creation date of the list.
updated_at int The latest update date for the list.
description string The name of the list.
origin string The origin of the list.
provider_id string The provider identifier for the list.
provider_data string The provider data for the list.
url string The URL for the list.

Get List


Returns a single list record.

Request

GET http://api.meshdata.io/apps/{app_id}/list/{list_id}

Response

HTTP/1.1 200 OK
{
    "created_at": 1468519861138,
    "deleted_at": 0,
    "description": "",
    "id": "5787d5b5791e4b1e0889b49a",
    "name": "User List 1",
    "origin": "sendgrid",
    "provider_id": 434682,
    "updated_at": 1468519861138,
    "url": "sendgrid.com/marketing_campaigns/lists/434682"
}

Get Lists


Returns multiple list records.

Request

GET http://api.meshdata.io/apps/{app_id}/lists

Response

HTTP/1.1 200 OK
{
    "lists" : [
        {
            "created_at": 1468519861138,
            "deleted_at": 0,
            "description": "",
            "id": "5787d5b5791e4b1e0889b49a",
            "name": "User List 1",
            "origin": "sendgrid",
            "provider_id": 434682,
            "updated_at": 1468519861138,
            "url": "sendgrid.com/marketing_campaigns/lists/434682"
        }.
        {...}
    ]
}

Get users for List


Returns users that are members in a list.

Request

GET http://api.meshdata.io/apps/{app_id}/lists/{list_id}/users

Response

HTTP/1.1 200 OK
{
    "users" : [
        {
            "created_at" : 1243435434543,
            "department": "Backfield",
            "description": "BeastMode",
            "email": "marshawn@beastmode.com",
            "fax": "",
            "first_name": "Marshawn",
            "full_name": "Marshawn Lynch",
            "id": "56a1c9715decd82dd00dfa62",
            "last_name": "Lynch",
            "mobile": "415-242-4242",
            "organization_name": "Seattle Seahawks",
            "organization_id": "34a1c3415decd78dd00dfa89",
            "origin": "salesforce",
            "phone": "",
            "priority": "high",
            "provider_data" : {},
            "title": "Running Back",
            "type": "Lead",
            "updated_at" : 1243435434543,
        }
        {...}
    ]
}

results matching ""

    No results matching ""