Tags


All Tags

You can get a list of all the tags of a campaign 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 tags Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Religion",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "has_custom_image": false,
            "is_private": true,
            "entity_id": 11,
            "tags": [],
            "created_at":  "2019-01-30T00:01:44.000000Z",
            "created_by": 1,
            "updated_at":  "2019-08-29T13:48:54.000000Z",
            "updated_by": 1,
            "type": "Lore",
            "tag_id": null,
            "colour": "green",
            "entities": [
              352, 
              440
            ]
        }
    ]
}

Tag

To get the details of a single tag, use the following endpoint.

Method Endpoint Headers
GET/HEAD tags/{tag.id} Default

Results

{
    "data": {
        "id": 1,
        "name": "Religion",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "has_custom_image": false,
        "is_private": true,
        "entity_id": 11,
        "tags": [],
        "created_at":  "2019-01-30T00:01:44.000000Z",
        "created_by": 1,
        "updated_at":  "2019-08-29T13:48:54.000000Z",
        "updated_by": 1,
        "type": "Lore",
        "colour": "green",
        "tag_id": null,
        "entities": [
          352, 440
        ]
    }

}

Create a Tag

To create a tag, use the following endpoint.

Method Endpoint Headers
POST tags Default

Body

Parameter Type Detail
name string (Required) Name of the tag
type string The tag's type
colour string The tag's colour
tag_id integer The parent tag
is_private boolean If the tag is only visible to admin members of the campaign
image stream Stream to file uploaded to the tag
image_url string URL to a picture to be used for the tag

Results

{success} Code 200 with JSON body of the new tag.

Update a Tag

To update a tag, use the following endpoint.

Method Endpoint Headers
PUT/PATCH tags/{tag.id} Default

Body

The same body parameters are available as for when creating a tag.

Results

{success} Code 200 with JSON body of the updated tag.

Delete a Tag

To delete a tag, use the following endpoint.

Method Endpoint Headers
DELETE tags/{tag.id} Default

Results

{success} Code 200 with JSON.