Delete a conversation from the user list
Changed onDelete a conversation from the user list. Does not delete the conversation for other receivers.
Request
- Base URLhttps://example.com/api
- Auth
- OAuth 2Authorization codehttps://example.com/oauth2/authorizeToken URLhttps://example.com/api/oauth2/tokenScopesconversation:write
- or API key in header XF-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
If true, further replies to this conversation will be ignored. (Otherwise, replies will restore this conversation to the list.)
Response
OK
Changes
- breaking
the
response's property type changed fromstringtobooleanfor status - warning
deleted the
pathrequest parameterid - info
api operation id
delete_conversations_id_removed and replaced withdeleteConversationsId - info
the endpoint scheme security
XF-Api-Keywas added to the API - info
the endpoint scheme security
XF-OAuth2was added to the API - info
added the new optional
headerrequest parameterXF-Api-Userto all path's operations - info
added the new optional
queryrequest parameterapi_bypass_permissionsto all path's operations
- breaking
- breaking
added the new path request parameter
id - breaking
the
response's property type changed frombooleantostringfor status - warning
the optional response header
XF-Latest-Api-Versionremoved for the status200 - warning
the optional response header
XF-Request-Userremoved for the status200 - warning
the optional response header
XF-Request-User-Extrasremoved for the status200 - warning
the optional response header
XF-Used-Api-Versionremoved for the status200 - info
api operation id
deleteConversationsIdremoved and replaced withdelete_conversations_id_ - info
the endpoint scheme security
XF-Api-Keywas removed from the API - info
the endpoint scheme security
XF-OAuth2was removed from the API
- breaking