> For the complete documentation index, see [llms.txt](https://docs.ushahidi.com/v3-ushahidi-platform-rest-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ushahidi.com/v3-ushahidi-platform-rest-api-documentation/v3/tags.md).

# Tags

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/tags" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

## Add tag

<mark style="color:green;">`POST`</mark> `ushahididocs.api.ushahidi.io/api/v3/tags`

#### Request Body

| Name        | Type    | Description                              |
| ----------- | ------- | ---------------------------------------- |
| parent\_id  | integer | Parent identifier for Tag                |
| icon        | String  | Tag icon name                            |
| description | String  | Tag description                          |
| color       | String  | Tag color                                |
| type        | String  | Type of tag                              |
| tag         | String  | Tag name                                 |
| role        | Array   | Tag role                                 |
| priority    | Integer | Tag priority value                       |
| children    | Array   | An array of other dependent children tag |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
  "id": 0,
  "url": "string",
  "parent_id": "string",
  "tag": "string",
  "slug": "string",
  "type": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "priority": 0,
  "created": "string",
  "role": [
    "string"
  ],
  "children": [
    "string"
  ],
  "allowed_privileges": [
    "string"
  ]
}
```

{% endtab %}
{% endtabs %}

## Edit tag

<mark style="color:orange;">`PUT`</mark> `ushahididocs.api.ushahidi.io/api/v3/tags/2`

#### Request Body

| Name        | Type    | Description                              |
| ----------- | ------- | ---------------------------------------- |
| parent\_id  | Integer | Parent identifier for Tag                |
| icon        | String  | Tag icon name                            |
| description | String  | Tag description                          |
| color       | String  | Tag color                                |
| type        | String  | Type of tag                              |
| tag         | String  | Tag name                                 |
| role        | Array   | Tag role                                 |
| priority    | Integer | Tag priority value                       |
| children    | Array   | An array of other dependent children tag |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
  "id": 0,
  "url": "string",
  "parent_id": "string",
  "tag": "string",
  "slug": "string",
  "type": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "priority": 0,
  "created": "string",
  "role": [
    "string"
  ],
  "children": [
    "string"
  ],
  "allowed_privileges": [
    "string"
  ]
}
```

{% endtab %}
{% endtabs %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/tags/5" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/tags/5" method="delete" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}