SupportWire API
API ReferenceConversations

Update conversation

Required scope: `conversations:write`.

PATCH
/api/oauth/v1/conversations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth access token, e.g. Authorization: Bearer swot_….

In: header

Path Parameters

id*string

Conversation ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/oauth/v1/conversations/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "string",
    "inserted_at": 0,
    "initial_message": "string",
    "is_spam": true,
    "last_message": "string",
    "last_message_inserted_at": 0,
    "status": "string",
    "user": {
      "id": "string",
      "name": "string",
      "email": "string",
      "instagram_handle": "string",
      "profile_picture_url": "string"
    },
    "pinned": true,
    "unread_count": 0,
    "summary": "string",
    "meta_info": {},
    "guest_submission": true,
    "group_id": "string",
    "group": {
      "id": "string",
      "name": "string",
      "slug": "string",
      "color": "string"
    },
    "conversation_assignee": {
      "id": "string",
      "conversation_id": "string",
      "user_id": "string",
      "assignor_id": "string",
      "assigned_at": 0
    }
  }
}