SupportWire API
API ReferenceMessages

Send message

Required scope: `messages:write`, `actor=self`.

POST
/api/oauth/v1/conversations/{conversation_id}/messages

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

conversation_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/oauth/v1/conversations/string/messages" \  -H "Content-Type: application/json" \  -d '{    "body_html": "string"  }'
{
  "data": {
    "id": "string",
    "conversation_id": "string",
    "source": "string",
    "is_spam": true,
    "inserted_at": 0,
    "body_html": "string",
    "marked_as_solution_at": 0,
    "user": {
      "id": "string",
      "name": "string",
      "email": "string",
      "instagram_handle": "string",
      "profile_picture_url": "string"
    },
    "meta_info": {},
    "is_ai_message": true,
    "reply_to": {
      "id": "string",
      "body_html": "string",
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "instagram_handle": "string",
        "profile_picture_url": "string"
      }
    },
    "attachments": [
      {
        "id": "string",
        "presigned_url": "string",
        "original_filename": "string",
        "extension": "string",
        "file_size": 0,
        "resource_type": "string",
        "resource_id": "string"
      }
    ]
  }
}
{
  "error": "insufficient_scope",
  "error_description": "The token is missing a required scope."
}
{
  "error": "insufficient_scope",
  "error_description": "The token is missing a required scope."
}