Skip to content

docs: Add Tags API endpoint documentation (#467)#481

Open
khawarlatifkhan wants to merge 13 commits into
mautic:7.0from
Promptless:promptless/issue-467-tags-api-page
Open

docs: Add Tags API endpoint documentation (#467)#481
khawarlatifkhan wants to merge 13 commits into
mautic:7.0from
Promptless:promptless/issue-467-tags-api-page

Conversation

@khawarlatifkhan
Copy link
Copy Markdown

Migrates Tags API documentation from legacy markdown to RST format. Verified against Mautic 7.0 source code - added the description field which was missing from legacy docs.

Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Comment thread docs/rest_api/tags.rst
@@ -1,14 +1,302 @@
Tags
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Migrated content structure and API endpoint patterns from the legacy Tags API documentation.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_endpoint_tags.md

@khawarlatifkhan khawarlatifkhan requested review from a team, adiati98 and favour-chibueze May 3, 2026 23:08
Comment thread docs/rest_api/tags.rst

``GET /tags/ID``

**Response**
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified Tag entity fields against Mautic 7.0 source. Added description field (line 59) which is exposed via loadApiMetadata() (lines 81-92) but was missing from legacy docs.

Source: https://github.com/mautic/mautic/blob/7.0/app/bundles/LeadBundle/Entity/Tag.php

@adiati98 adiati98 requested a review from a team May 11, 2026 08:38
@adiati98
Copy link
Copy Markdown
Contributor

@mautic/core-team can you please review the content here? TIA! ✨

Copy link
Copy Markdown
Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good! Just 2 small suggestions

Comment thread docs/rest_api/tags.rst Outdated
Comment thread docs/rest_api/tags.rst Outdated
Update array() to [] shorthand syntax for Create Tag and Edit Tag
code examples per reviewer feedback.
Copy link
Copy Markdown
Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants