GET /v1/token/message

HTTP Method: GET

Path: /v1/token/message

Authentication: API Key required

Description: Get a URL that allows a user to message an entity (index card) via the Central Index 

Parameters:

parameter type description Required
entity_id string The id of the entity being messaged Yes
language string An ISO compatible language code. Default is en No
portal_name string The name of the website that message is coming from e.g. Your Local Yes

Sample Response:

{
    "success": true,
    "msg": "Token URL",
    "data": "http://staging.admin.centralindex.com/message/login?token=1ea87836edbadbae962201b3a7440c93f7624760724785c96b4bda8705490d7f6bed6a4d46e76bbcfd7570d160f4b5d3f5148ab660bc29839c60d35e73c9f98d74a07a73b39057eec788f732521d3bc49ef7ff21f8379e0987cd1dbbef9761ecd0c156d1973d8675c71c15dfec7289e436a4ade0c657bf361d862b0eb900d373"
}

 

The API call returns a URL which your user's can be redirected to to allow them to message a business on the Central Index. 

Because this is a key-specific URL, the Central Index knows when a message is sent via your application.

Docs Navigation