# Tags

---

- [All Tags](#all-tags)
- [Single Tag](#tag)
- [Create a Tag](#create-tag)
- [Update a Tag](#update-tag)
- [Delete a Tag](#delete-tag)

<a name="all-tags"></a>
## 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/{{version}}/campaigns/{campaign.id}/`.


| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `tags` | Default |

### Results
```json
{
    "data": [
        {
            "id": 1,
            "name": "Religion",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": true,
            "entity_id": 11,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 10:55:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": 1,
            "updated_at": {
                "date": "2018-09-20 09:18:58.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "type": "Lore",
            "tag_id": null,
            "entities": [
              352, 440
            ]
        }
    ]
}
```


<a name="tag"></a>
## Tag

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

| Method | Endpoint| Headers |
| :- |   :-   |  :-  |
| GET/HEAD | `tags/{tag.id}` | Default |

### Results
```json
{
    "data": {
        "id": 1,
        "name": "Religion",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "is_private": true,
        "entity_id": 11,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 10:55:08.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": 1,
        "updated_at": {
            "date": "2018-09-20 09:18:58.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "type": "Lore",
        "tag_id": null,
        "entities": [
          352, 440
        ]
    }
    
}
```


<a name="create-tag"></a>
## 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 |
| `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.


<a name="update-tag"></a>
## 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.


<a name="delete-tag"></a>
## 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.