Add or remove a tag on one participant.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Adds or removes a tag on one participant. The tag is tracked in the participant's tags field.
Unlike /v1/event/tag, this does not modify the event title. It only updates the participant's tags field.
The tags value returned for a participant (and the tags it is searchable by) is the union of the participant's own tags and, when the participant is linked to a contact, that contact's tags. Adding or removing a tag through this endpoint only changes the participant's own tags; a contact's tags are managed through /v1/contacts/tag.
- The
tagvalue may be sent with or without a leading#. The#is added automatically, sovipand#vipare equivalent. - Adding a tag that is already present is a no-op. Removing a tag that is not present is a no-op.
- Set
remove=trueto remove the tag instead of adding it.
Identify the participant with the Apptoto id.
Parameters
| Parameter | Required | Description |
|---|---|---|
id | Yes | The Apptoto id for the participant. |
tag | Yes | The tag to add or remove. A leading # is optional and is added automatically (e.g. vip and #vip are equivalent). |
remove | No | Set to true to remove the tag instead of adding it. Defaults to adding the tag. |
Example Result:
{
id: 789,
event_id: 123,
display_name: "Fred Smith",
name: "Fred Smith",
phone: "650-555-1212",
normalized_phone: "+16505551212",
email: "[email protected]",
state: "initial",
check_in_state: "",
tags: "#vip",
contact_id: 555,
contact_external_id: "your-external-id"
}OAuth scope
Calls authenticated with an OAuth 2.0 bearer token must include the events:write scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.