User mentioned
any of the below objects
The user, or user group, mentioned and returned from the comments API
A user mention
Users can be mentioned by including the userId or email surrounded by @[]
in the text field of the request body
{"text": "...@[userId]....@[userEmail]..."}
Responses from listing, creating, or updating comments
will indicate user mentions by including the userId surrounded by
the same @[]
in the text field of the response body. The response will also
include a mentioned
objectMap that maps mentioned user and user group ids
to detailed information
If you wish to have a list of all possible user ids, these can be found:
- from the admin panel, by downloading the CSV available from the Users table
- from Airtable's Enterprise API
- by using automations or the scripting extension
{"mentioned": {"userId": {"type": "user","id": "userId","name": "User Name","email": "User Email"}}}
string A user ID | |
"user" | |
string | |
string |
A user group mention
User Groups can be mentioned by including the userGroupId surrounded by @[]
in the text field of the request body
{"text": "...@[userGroupId]..."}
Responses from listing, creating, or updating comments
will indicate user group mentions by including the userGroupId surrounded by
the same @[]
in the text field of the response body. It will also include
a mentions
objectMap that maps mentioned user and group ids to detailed information.
If you wish to have a list of all possible user group ids, these can be found:
- from the admin panel, by downloading the CSV available from the Groups table
- from Airtable's Enterprise API
- by using automations or the scripting extension
{"mentioned": {"userGroupId": {"type": "userGroup","id": "userGroupId","name": "Group Name"}}}
string A user group ID | |
"userGroup" | |
string |