description:Magic link token for passwordless guest authentication. When provided, authenticates the user using the magic link token instead of password. Requires guest magic link feature to be enabled.
Create a new user on the system. Password is required for email login.
For other authentication types such as LDAP or SAML, auth_data and
auth_service fields are required.
##### Permissions
Nopermission required for creating email/username accounts on an open server. Auth Token is required for other authentication types such as LDAP or SAML.
description:Service-specific authentication data, such as email address.
type:string
auth_service:
description:The authentication service, one of "email", "gitlab",
"ldap","saml","office365","google",and "".
type:string
password:
description:The password used for email authentication.
type:string
locale:
type:string
props:
type:object
notify_props:
$ref:"#/components/schemas/UserNotifyProps"
description:User object to be created
required:true
responses:
"201":
description:User creation successful
content:
application/json:
schema:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"403":
$ref:"#/components/responses/Forbidden"
get:
tags:
- users
summary:Get users
description:>
Get a page of a list of users. Based on query string parameters, select
users from a team, channel, or select users not in a specific channel.
Since server version 4.0, some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.
Some fields, like `email_verified` and `notify_props`, are only visible for the authorized user or if the authorized user has the `manage_system` permission.
When left blank, sorting is done by username. `status` will sort by User's current status (Online, Away, DND, Offline), then by Username.
__Minimum server version__:4.7
##### `in_group`
Can be "", "display_name".
When left blank, sorting is done by username. `display_name` will sort alphabetically by user's display name.
__Minimum server version__:7.7
schema:
type:string
- name:roles
in:query
description:>
Comma separated string used to filter users based on any of the specified system roles
Example:`?roles=system_admin,system_user` will return users that are either system admins or system users
__Minimum server version__:5.26
schema:
type:string
- name:channel_roles
in:query
description:>
Comma separated string used to filter users based on any of the specified channel roles, can only be used in conjunction with `in_channel`
Example:`?in_channel=4eb6axxw7fg3je5iyasnfudc5y&channel_roles=channel_user` will return users that are only channel users and not admins or guests
__Minimum server version__:5.26
schema:
type:string
- name:team_roles
in:query
description:>
Comma separated string used to filter users based on any of the specified team roles, can only be used in conjunction with `in_team`
Example:`?in_team=4eb6axxw7fg3je5iyasnfudc5y&team_roles=team_user` will return users that are only team users and not admins or guests
__Minimum server version__:5.26
schema:
type:string
responses:
"200":
description:User page retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
delete:
tags:
- users
summary:Permanent delete all users
description:>
Permanently deletes all users and all their related information, including posts.
__Minimum server version__:5.26.0
__Local mode only__:This endpoint is only available through [local mode](https://docs.mattermost.com/administration/mmctl-cli-tool.html#local-mode).
operationId:PermanentDeleteAllUsers
responses:
"200":
description:Delete request was successful
/api/v4/users/ids:
post:
tags:
- users
summary:Get users by ids
description:|
Get a list of users based on a provided list of user ids.
##### Permissions
Requires an active session but no other permissions.
operationId:GetUsersByIds
parameters:
- name:since
in:query
description:>
Only return users that have been modified since the given Unix
timestamp (in milliseconds).
__Minimum server version__:5.14
schema:
type:integer
requestBody:
content:
application/json:
schema:
type:array
items:
type:string
description:List of user ids
required:true
responses:
"200":
description:User list retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
/api/v4/users/group_channels:
post:
tags:
- users
summary:Get users by group channels ids
description:|
Get an object containing a key per group channel id in the
query and its value as a list of users members of that group
channel.
The user must be a member of the group ids in the query, or
they will be omitted from the response.
##### Permissions
Requires an active session but no other permissions.
__Minimum server version__:5.14
operationId:GetUsersByGroupChannelIds
requestBody:
content:
application/json:
schema:
type:array
items:
type:string
description:List of group channel ids
required:true
responses:
"200":
description:User list retrieval successful
content:
application/json:
schema:
type:object
properties:
<CHANNEL_ID>:
type:array
items:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
/api/v4/users/usernames:
post:
tags:
- users
summary:Get users by usernames
description:|
Get a list of users based on a provided list of usernames.
##### Permissions
Requires an active session but no other permissions.
operationId:GetUsersByUsernames
requestBody:
content:
application/json:
schema:
type:array
items:
type:string
description:List of usernames
required:true
responses:
"200":
description:User list retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
/api/v4/users/search:
post:
tags:
- users
summary:Search users
description:>
Get a list of users based on search criteria provided in the request
body. Searches are typically done against username, full name, nickname
and email unless otherwise configured by the server.
##### Permissions
Requires an active session and `read_channel` and/or `view_team` permissions for any channels or teams specified in the request body.
operationId:SearchUsers
requestBody:
content:
application/json:
schema:
type:object
required:
- term
properties:
term:
description:The term to match against username, full name, nickname and
email
type:string
team_id:
description:If provided, only search users on this team
type:string
not_in_team_id:
description:If provided, only search users not on this team
type:string
in_channel_id:
description:If provided, only search users in this channel
type:string
not_in_channel_id:
description:If provided, only search users not in this channel. Must
specifiy `team_id` when using this option
type:string
in_group_id:
description:If provided, only search users in this group. Must
have `manage_system` permission.
type:string
group_constrained:
description:When used with `not_in_channel_id` or `not_in_team_id`,
returns only the users that are allowed to join the channel
or team based on its group constrains.
type:boolean
allow_inactive:
description:When `true`, include deactivated users in the results
type:boolean
without_team:
type:boolean
description:Set this to `true` if you would like to search for users
that are not on a team. This option takes precendence over
`team_id`, `in_channel_id`, and `not_in_channel_id`.
limit:
description:>
The maximum number of users to return in the results
__Available as of server version 5.6. Defaults to `100` if not provided or on an earlier server version.__
type:integer
default:100
description:Search criteria
required:true
responses:
"200":
description:User list retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
/api/v4/users/autocomplete:
get:
tags:
- users
summary:Autocomplete users
description:>
Get a list of users for the purpose of autocompleting based on the
provided search term. Specify a combination of `team_id` and
`channel_id` to filter results further.
##### Permissions
Requires an active session and `view_team` and `read_channel` on any teams or channels used to filter the results further.
operationId:AutocompleteUsers
parameters:
- name:team_id
in:query
description:Team ID
schema:
type:string
- name:channel_id
in:query
description:Channel ID
schema:
type:string
- name:name
in:query
description:Username, nickname first name or last name
required:true
schema:
type:string
- name:limit
in:query
description:>
The maximum number of users to return in each subresult
__Available as of server version 5.6. Defaults to `100` if not provided or on an earlier server version.__
schema:
type:integer
default:100
responses:
"200":
description:User autocomplete successful
content:
application/json:
schema:
$ref:"#/components/schemas/UserAutocomplete"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
/api/v4/users/known:
get:
tags:
- users
summary:Get user IDs of known users
description:|
Get the list of user IDs of users with any direct relationship with a
user. That means any user sharing any channel, including direct and
group channels.
##### Permissions
Must be authenticated.
__Minimum server version__:5.23
operationId:GetKnownUsers
responses:
"200":
description:Known users' IDs retrieval successful
content:
application/json:
schema:
type:array
$ref:"#/components/schemas/KnownUsers"
"401":
$ref:"#/components/responses/Unauthorized"
/api/v4/users/stats:
get:
tags:
- users
summary:Get total count of users in the system
description:|
Get a total count of users in the system.
##### Permissions
Must be authenticated.
operationId:GetTotalUsersStats
responses:
"200":
description:User stats retrieval successful
content:
application/json:
schema:
$ref:"#/components/schemas/UsersStats"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"404":
$ref:"#/components/responses/NotFound"
/api/v4/users/stats/filtered:
get:
tags:
- users
summary:Get total count of users in the system matching the specified filters
description:|
Get a count of users in the system matching the specified filters.
__Minimum server version__:5.26
##### Permissions
Must have `manage_system` permission.
operationId:GetTotalUsersStatsFiltered
parameters:
- name:in_team
in:query
description:The ID of the team to get user stats for.
schema:
type:string
- name:in_channel
in:query
description:The ID of the channel to get user stats for.
schema:
type:string
- name:include_deleted
in:query
description:If deleted accounts should be included in the count.
schema:
type:boolean
- name:include_bots
in:query
description:If bot accounts should be included in the count.
schema:
type:boolean
- name:roles
in:query
description:>
Comma separated string used to filter users based on any of the specified system roles
Example:`?roles=system_admin,system_user` will include users that are either system admins or system users
schema:
type:string
- name:channel_roles
in:query
description:>
Comma separated string used to filter users based on any of the specified channel roles, can only be used in conjunction with `in_channel`
Example:`?in_channel=4eb6axxw7fg3je5iyasnfudc5y&channel_roles=channel_user` will include users that are only channel users and not admins or guests
schema:
type:string
- name:team_roles
in:query
description:>
Comma separated string used to filter users based on any of the specified team roles, can only be used in conjunction with `in_team`
Example:`?in_team=4eb6axxw7fg3je5iyasnfudc5y&team_roles=team_user` will include users that are only team users and not admins or guests
schema:
type:string
responses:
"200":
description:Filtered User stats retrieval successful
content:
application/json:
schema:
$ref:"#/components/schemas/UsersStats"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"404":
$ref:"#/components/responses/NotFound"
"/api/v4/users/{user_id}":
get:
tags:
- users
summary:Get a user
description:|
Get a user a object. Sensitive information will be sanitized out.
##### Permissions
Requires an active session but no other permissions.
operationId:GetUser
parameters:
- name:user_id
in:path
description:User GUID. This can also be "me" which will point to the current user.
required:true
schema:
type:string
responses:
"200":
description:User retrieval successful
content:
application/json:
schema:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"404":
$ref:"#/components/responses/NotFound"
put:
tags:
- users
summary:Update a user
description:>
Update a user by providing the user object. The fields that can be
updated are defined in the request body, all other provided fields will
be ignored. Any fields not included in the request body will be set to
nullor reverted to default values.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.
operationId:UpdateUser
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
requestBody:
content:
application/json:
schema:
type:object
required:
- id
- email
- username
properties:
id:
type:string
email:
type:string
username:
type:string
first_name:
type:string
last_name:
type:string
nickname:
type:string
locale:
type:string
position:
type:string
timezone:
$ref:"#/components/schemas/Timezone"
props:
type:object
notify_props:
$ref:"#/components/schemas/UserNotifyProps"
description:User object that is to be updated
required:true
responses:
"200":
description:User update successful
content:
application/json:
schema:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
delete:
tags:
- users
summary:Deactivate a user account.
description:>
Deactivates the user and revokes all its sessions by archiving its user
object.
As of server version 5.28, optionally use the `permanent=true` query parameter to permanently delete the user for compliance reasons. To use this feature `ServiceSettings.EnableAPIUserDeletion` must be set to `true` in the server's configuration.
##### Permissions
Must be logged in as the user being deactivated or have the `edit_other_users` permission.
operationId:DeleteUser
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
responses:
"200":
description:User deactivation successful
content:
application/json:
schema:
$ref:"#/components/schemas/StatusOK"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"404":
$ref:"#/components/responses/NotFound"
"/api/v4/users/{user_id}/patch":
put:
tags:
- users
summary:Patch a user
description:>
Partially update a user by providing only the fields you want to update.
Omitted fields will not be updated. The fields that can be updated are
defined in the request body, all other provided fields will be ignored.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.
__Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.__
##### Permissions
User can deactivate themselves.
User with `manage_system` permission can activate or deactivate a user.
Must be logged in as the user or have the `edit_other_users` permission.
operationId:GetUserAudits
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
responses:
"200":
description:User audits retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/Audit"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"/api/v4/users/{user_id}/email/verify/member":
post:
tags:
- users
summary:Verify user email by ID
description:|
Verify the email used by a user without a token.
__Minimum server version__:5.24
##### Permissions
Must have `manage_system` permission.
operationId:VerifyUserEmailWithoutToken
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
responses:
"200":
description:User email verification successful
content:
application/json:
schema:
$ref:"#/components/schemas/User"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"404":
$ref:"#/components/responses/NotFound"
/api/v4/users/email/verify:
post:
tags:
- users
summary:Verify user email
description:|
Verify the email used by a user to sign-up their account with.
##### Permissions
Nopermissions required.
operationId:VerifyUserEmail
requestBody:
content:
application/json:
schema:
type:object
required:
- token
properties:
token:
description:The token given to validate the email
type:string
required:true
responses:
"200":
description:User email verification successful
content:
application/json:
schema:
$ref:"#/components/schemas/StatusOK"
"400":
$ref:"#/components/responses/BadRequest"
/api/v4/users/email/verify/send:
post:
tags:
- users
summary:Send verification email
description:>
Send an email with a verification link to a user that has an email
matching the one in the request body. This endpoint will return success
even if the email does not match any users on the system.
##### Permissions
Nopermissions required.
operationId:SendVerificationEmail
requestBody:
content:
application/json:
schema:
type:object
required:
- email
properties:
email:
description:Email of a user
type:string
required:true
responses:
"200":
description:Email send successful if email exists
content:
application/json:
schema:
$ref:"#/components/schemas/StatusOK"
"400":
$ref:"#/components/responses/BadRequest"
/api/v4/users/login/switch:
post:
tags:
- users
summary:Switch login method
description:>
Switch a user's login method from using email to OAuth2/SAML/LDAP or
back to email. When switching to OAuth2/SAML, account switching is not
complete until the user follows the returned link and completes any
steps on the OAuth2/SAML service provider.
To switch from email to OAuth2/SAML, specify `current_service`, `new_service`, `email` and `password`.
To switch from OAuth2/SAML to email, specify `current_service`, `new_service`, `email` and `new_password`.
To switch from email to LDAP/AD, specify `current_service`, `new_service`, `email`, `password`, `ldap_ip` and `new_password` (this is the user's LDAP password).
To switch from LDAP/AD to email, specify `current_service`, `new_service`, `ldap_ip`, `password` (this is the user's LDAP password), `email` and `new_password`.
Additionally, specify `mfa_code` when trying to switch an account on LDAP/AD or email that has MFA activated.
##### Permissions
Nocurrent authentication required except when switching from OAuth2/SAML to email.
operationId:SwitchAccountType
requestBody:
content:
application/json:
schema:
type:object
required:
- current_service
- new_service
properties:
current_service:
description:The service the user currently uses to login
type:string
new_service:
description:The service the user will use to login
type:string
email:
description:The email of the user
type:string
password:
description:The password used with the current service
type:string
mfa_code:
description:The MFA code of the current service
type:string
ldap_id:
description:The LDAP/AD id of the user
type:string
required:true
responses:
"200":
description:Login method switch or request successful
content:
application/json:
schema:
type:object
properties:
follow_link:
description:The link for the user to follow to login or to complete
Get the authentication service type (auth_service) for a user to determine
how they should authenticate. This endpoint is typically used in the login flow
to determine which authentication method to use.
For this version, the endpoint only returns a non-empty `auth_service` if the user has magic_link enabled.
For all other authentication methods (email/password, OAuth, SAML, LDAP), an empty string is returned.
##### Permissions
Nopermission required
operationId:GetLoginType
requestBody:
content:
application/json:
schema:
type:object
properties:
id:
description:The user ID (optional, can be used with login_id)
type:string
login_id:
description:The login ID (email, username, or unique identifier)
type:string
device_id:
description:The device ID for audit logging purposes
type:string
description:Login type request object
required:true
responses:
"200":
description:Login type retrieved successfully
content:
application/json:
schema:
type:object
properties:
auth_service:
description:The authentication service type. Returns the actual service type if guest_magic_link is enabled (in which case a magic link is also sent to the user's email). Returns an empty string for all other authentication methods.
Updates a user's authentication method. This can be used to change them
to/from LDAP authentication for example.
__Minimum server version__:4.6
##### Permissions
Must have the `edit_other_users` permission.
operationId:UpdateUserAuth
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
requestBody:
content:
application/json:
schema:
$ref:"#/components/schemas/UserAuthData"
required:true
responses:
"200":
description:User auth update successful
content:
application/json:
schema:
$ref:"#/components/schemas/UserAuthData"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"501":
$ref:"#/components/responses/NotImplemented"
"/api/v4/users/{user_id}/terms_of_service":
post:
tags:
- users
- terms of service
summary:Records user action when they accept or decline custom terms of service
description:>
Records user action when they accept or decline custom terms of service.
Records the action in audit table.
Updates user's last accepted terms of service ID if they accepted it.
__Minimum server version__:5.4
##### Permissions
Must be logged in as the user being acted on.
operationId:RegisterTermsOfServiceAction
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
requestBody:
content:
application/json:
schema:
type:object
required:
- serviceTermsId
- accepted
properties:
serviceTermsId:
description:terms of service ID on which the user is acting on
type:string
accepted:
description:trueor false, indicates whether the user accepted or
rejected the terms of service.
type:string
description:terms of service details
required:true
responses:
"200":
description:Terms of service action recorded successfully
content:
application/json:
schema:
$ref:"#/components/schemas/StatusOK"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
get:
tags:
- users
- terms of service
summary:Fetches user's latest terms of service action if the latest action was
for acceptance.
description:>
Will be deprecated in v6.0
Fetches user's latest terms of service action if the latest action was for acceptance.
__Minimum server version__:5.6
##### Permissions
Must be logged in as the user being acted on.
operationId:GetUserTermsOfService
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
responses:
"200":
description:User's accepted terms of service action
content:
application/json:
schema:
$ref:"#/components/schemas/UserTermsOfService"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"404":
description:User hasn't performed an action or the latest action was a rejection.
content:
application/json:
schema:
$ref:"#/components/schemas/AppError"
/api/v4/users/sessions/revoke/all:
post:
tags:
- users
summary:Revoke all sessions from all users.
description:>
For any session currently on the server (including admin) it will be
revoked.
Clients will be notified to log out users.
__Minimum server version__:5.14
##### Permissions
Must have `manage_system` permission.
operationId:RevokeSessionsFromAllUsers
responses:
"200":
description:Sessions successfully revoked.
"401":
$ref:"#/components/responses/Unauthorized"
"403":
$ref:"#/components/responses/Forbidden"
"/api/v4/users/{user_id}/typing":
post:
tags:
- users
summary:Publish a user typing websocket event.
description:>
Notify users in the given channel via websocket that the given user is typing.
__Minimum server version__:5.26
##### Permissions
Must have `manage_system` permission to publish for any user other than oneself.
operationId:PublishUserTyping
parameters:
- name:user_id
in:path
description:User GUID
required:true
schema:
type:string
requestBody:
content:
application/json:
schema:
type:object
required:
- channel_id
properties:
channel_id:
description:The id of the channel to which to direct the typing event.
type:string
parent_id:
description:The optional id of the root post of the thread to which the user is replying. If unset, the typing event is directed at the entire channel.
type:string
responses:
'200':
description:User typing websocket event accepted for publishing.
'400':
$ref:"#/components/responses/BadRequest"
'401':
$ref:"#/components/responses/Unauthorized"
'403':
$ref:"#/components/responses/Forbidden"
"/api/v4/users/{user_id}/uploads":
get:
tags:
- users
summary:Get uploads for a user
description:|
Gets all the upload sessions belonging to a user.
__Minimum server version__:5.28
##### Permissions
Must be logged in as the user who created the upload sessions.
operationId:GetUploadsForUser
parameters:
- name:user_id
in:path
description:The ID of the user. This can also be "me" which will point to the current user.
required:true
schema:
type:string
responses:
"200":
description:User's uploads retrieval successful
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/UploadSession"
"400":
$ref:"#/components/responses/BadRequest"
"401":
$ref:"#/components/responses/Unauthorized"
"404":
$ref:"#/components/responses/NotFound"
"/api/v4/users/{user_id}/channel_members":
get:
tags:
- users
summary:Get all channel members from all teams for a user
description:|
Get all channel members from all teams for a user.
__Minimum server version__:6.2.0
##### Permissions
Logged in as the user, or have `edit_other_users` permission.
operationId:GetChannelMembersWithTeamDataForUser
parameters:
- name:user_id
in:path
description:The ID of the user. This can also be "me" which will point to the current user.
summary:Mark a thread that user is following as unread based on a post id
description:|
Mark a thread that user is following as unread
__Minimum server version__:6.7
##### Permissions
Must have `read_channel` permission for the channel the thread is in or if the channel is public, have the `read_public_channels` permission for the team.
Must have `edit_other_users` permission if the user is not the one marking the thread for himself.
operationId:SetThreadUnreadByPostId
parameters:
- name:user_id
in:path
description:The ID of the user. This can also be "me" which will point to the current user.
required:true
schema:
type:string
- name:team_id
in:path
description:The ID of the team in which the thread is.
required:true
schema:
type:string
- name:thread_id
in:path
description:The ID of the thread to update
required:true
schema:
type:string
- name:post_id
in:path
description:The ID of a post belonging to the thread to mark as unread.
