Entity Links


All Entity Links

You can get a list of all the entity-links of an entity by using the following endpoint.

{warning} Don't forget that all endpoints documented here need to be prefixed with api/1.0/campaigns/{campaign.id}/.

Method Endpoint Headers
GET/HEAD entities/{entity.id}/entity_links Default

Results

{
    "data": [
        {
            "created_at":  "2021-01-30T00:01:44.000000Z",
            "created_by": 1,
            "entity_id": 69,
            "id": 31,
            "visibility": "all",
            "name": "DNDbeyond",
            "url": "{url}",
            "icon": "",
            "position": 1,
            "updated_at":  "2021-01-31T13:48:54.000000Z",
            "updated_by": null
        }
    ]
}

Entity Link

To get the details of a single entity-link, use the following endpoint.

Method Endpoint Headers
GET/HEAD entities/{entity.id}/entity_links/{entity_link.id} Default

Results

{
    "data": {
        "created_at":  "2021-01-30T00:01:44.000000Z",
        "created_by": 1,
        "entity_id": 69,
        "id": 31,
        "visibility": "all",
        "name": "DNDbeyond",
        "url": "{url}",
        "icon": "",
        "position": 1,
        "updated_at":  "2021-01-31T13:48:54.000000Z",
        "updated_by": null
    }
}

Create an Entity Link

To create an entity-link, use the following endpoint.

Method Endpoint Headers
POST entities/{entity.id}/entity_links Default

Body

Parameter Type Detail
name string The name of the link
icon string The icon of the link
url string The url of the link
position int Optional position of the entity link
visibility string The visibility: all, self, admin, self-admin or members.

Results

{success} Code 200 with JSON body of the new entity-link.

Delete an Entity Link

To delete an entity-link, use the following endpoint.

Method Endpoint Headers
DELETE entities/{entity.id}/entity_links/{entity_link.id} Default

Results

{success} Code 200 with JSON.