Skip to content

H&S - Tagging Users

Tags need to be defined in your account before they can be added to your users. This can be done via the website or via the API. This section of the documentation assumes some tags already exist for your account.

To add tag 12 to one of your users, with an expiry date and an explanatory note, you would include the following XML in either the user PUT or POST.

<taggings type="array">
    <tagging>
        <tag_id>12</tag_id>
        <notes>Some notes to save against the tagging</notes>
        <expires_at>2017-05-30T12:00:00Z</expires_at>
    </tagging>
</taggings>

If you wanted to update the user's tag with some new content, like a note, you would include the following XML in a user PUT. (In this situation, you reference the tag ID from the user, not the tag ID from the account.)

<taggings type="array">
    <tagging>
        <id>109</id>
        <notes>Some updated notes</notes>
    </tagging>
</taggings>

To remove tag 109 from user 12345, you would send a DELETE command to the following URL. (In this situation, you reference the tag ID from the user, not the tag ID from the account.)

https://api.vworkapp.com/api/v4/user/12345/taggings/109.xml?api_key=123