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 


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": ""


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