Skip to main content
Tags are organization-defined labels for resources such as invoices. They are useful for review queues, internal workflows, and grouping resources in your integration. Resource tags are separate from entity tags:
Tag typeUsed forIRI format
Resource tagsSupported resources such as invoices/tags/{id}
Entity tagsEntities/entity-tags/{id}
When applying tags to a resource, send the complete tags collection you want the resource to have. The submitted collection replaces the previous collection.
Entity tag operations are listed under Entities because they label entities. This section covers resource tags.

​
How Tags Are Used

  1. Create a tag for the resource type you want to label.
  2. Store the tag IRI returned by Syntage, such as /tags/{id}.
  3. Update the resource with the complete tags collection it should have.
  4. Use tags in your own integration to build queues, review states, grouping, or reconciliation workflows.

​
Tag Color

Both resource tags and entity tags accept an optional color on create and update. Use it to render each tag with a consistent color in your dashboards, reports, or exports.
  • Send a 7-character hexadecimal string in the form #RRGGBB. Colors are stored in lowercase.
  • Omit the field or send null to keep the default color (#a3aab5).
  • Changing a tag’s color updates every resource that already references the tag.

​
Replacing Tag Assignments

When an endpoint accepts a tags collection, the request replaces the resource’s existing tag assignments. To add one tag without removing the current tags, first retrieve the resource, keep its existing tag IRIs, append the new tag IRI, and send the full list back. For endpoint details, see Tags API Reference.