delete
Remove conversation

https://CounterSocial.example/api/v1/conversations/:id

Returns: empty object
OAuth: User token + write:conversations
Version history:
2.6.0 - added

Request

Path Parameters
:id
required
string
ID of the conversation in the database
Headers
Authorization
required
string

Response

200: Success

An empty object will be returned.

{}

401: Unauthorized

Invalid or missing Authentication header

{
  "error": "The access token is invalid"
}

404: Not Found

The conversation does not exist, or is not owned by you.

{
  "error": "Record not found"
}

post
Mark as read

https://CounterSocial.example/api/v1/conversations/:id/read

Returns: Conversation
OAuth: User token + write:conversations
Version history:
2.6.0 - added

Request

Path Parameters
:id
optional
string
ID of the conversation in the database
Headers
Authorization
required
string

Response

200: Success

The value of unread has been changed to false.

{
  "id": "418450",
  "unread": false,
  "accounts": [
    {
      "id": "482403",
      ...
    }
  ],
  "last_status": {
    "id": "103196583826321184",
    ...
  }
}

401: Unauthorized

Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

404: Not Found

The conversation does not exist, or is not owned by you.

{
  "error": "Record not found"
}

Last updated December 27, 2020 ?? Improve this page