Organizations

The organization resource represents an organization that has been synchronized from one or many of the Mesh integrations.

Organization records can also be created, updated or deleted via the Mesh API. API actions can optionally be mirrored in an application's activated integrations.

The primary key upon which the Mesh service uniques organization records is a organization's website. The secondary key is the organization's name. When Mesh encounters multiple organization records with the same website or name, it will combine the records by appending information from the new record to the existing. It will not override information for the existing record.

Provider Mapping


Provider Model URL
Salesforce account http://developers.salesforce.com
Hubspot company http://developers.hubspot.com/docs/overview
Zendesk organization https://developer.zendesk.com/rest_api/docs/core/organizations
Intercom company https://developers.intercom.io/reference#companies

Model


Field Type Description
id string The the Mesh identifier for the organization.
created_at int The original creation date of the organization.
updated_at int The latest update date for the organization.
name string The name of the organization.
website string The website for the organization.
industry string The industry for the organization.
size string The size of the organization.
priority string The priority for the organization.
annual_revenue string The projected annual revenue for the organization.
street string The street for the organization.
city string The city for the organization.
state string The state for the organization.
zip_code string The zip code for the organization.
country string The country for the organization.
description string The description of the organization.

Create Organization


Creates a new organization record. This action can also optionally create a user record in each activated integration for the application.

Request

POST http://api.meshdata.io/apps/{app_id}/organizations/{organization_id}
{
    "annual_revenue": "200000000",
    "city": "Seattle",
    "country": "USA",
    "description": "Super Bowl XLVII Champions",
    "industry": "Professional Football",
    "name": "Seattle Seahawks",
    "priority": "high",
    "size": "52",
    "state": "WA"
    "street": "800 Occidental Ave S",
    "website": "http://www.seahawks.com/",
    "zip_code": "98134",
}

Response

HTTP/1.1 201 Created
{
    "id": "56a1c9715decd82dd00dfa62",
    "annual_revenue": "200000000",
    "city": "Seattle",
    "country": "USA",
    "created_at" : 1243435434543,
    "description": "Super Bowl XLVII Champions",
    "industry": "Professional Football",
    "name": "Seattle Seahawks",
    "priority": "high",
    "provider_data" : {},
    "size": "52",
    "state": "WA"
    "street": "800 Occidental Ave S",
    "updated_at" : 1243435434543,
    "website": "http://www.seahawks.com/",
    "zip_code": "98134",
}

Update Organization


Updates an existing organization record. This action can also optionally update the corresponding organization record in each activated integration.

Request

PUT http://api.meshdata.io/apps/{app_id}/organizations/{organization_id}

Response

HTTP/1.1 204 No Content

Delete Organization


Deletes an existing organization record. Deleting organizations via the Mesh API is a non-recoverable operation. This action will also delete the corresponding organization record in each activated integrations.

Request

DELETE http://api.meshdata.io/apps/{app_id}/organizations/{organization_id}

Response

HTTP/1.1 204 No Content

Get Organization


Fetches a single organization record.

Request

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

Response

HTTP/1.1 200 OK
{
    "id": "56a1c9715decd82dd00dfa62",
    "annual_revenue": "200000000",
    "city": "Seattle",
    "country": "USA",
    "created_at" : 1243435434543,
    "description": "Super Bowl XLVII Champions",
    "industry": "Professional Football",
    "name": "Seattle Seahawks",
    "priority": "high",
    "provider_data" : {},
    "size": "52",
    "state": "WA"
    "street": "800 Occidental Ave S",
    "updated_at" : 1243435434543,
    "website": "http://www.seahawks.com/",
    "zip_code": "98134",
}

Get Organizations


Fetches multiple organization records.

Request

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

Response

HTTP/1.1 200 OK

{
    "organizations" : [
        {
            "id": "56a1c9715decd82dd00dfa62",
            "annual_revenue": "200000000",
            "city": "Seattle",
            "country": "USA",
            "created_at" : 1243435434543,
            "description": "Super Bowl XLVII Champions",
            "industry": "Professional Football",
            "name": "Seattle Seahawks",
            "priority": "high",
            "provider_data" : {},
            "size": "52",
            "state": "WA"
            "street": "800 Occidental Ave S",
            "updated_at" : 1243435434543,
            "website": "http://www.seahawks.com/",
            "zip_code": "98134",
        },
        {...}
    ]
}

results matching ""

    No results matching ""