Skip to main content
PATCH
/
v1
/
messages
/
{id}
Update message
curl --request PATCH \
  --url https://api.shingleai.com/v1/messages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readAt": "2024-01-15T10:30:00Z",
  "archivedAt": "2024-01-15T12:00:00Z",
  "snoozedUntil": "2024-01-16T09:00:00Z"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "timestamp": "2023-11-07T05:31:56Z",
    "readAt": "2023-11-07T05:31:56Z",
    "archivedAt": "2023-11-07T05:31:56Z",
    "snoozedUntil": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "email",
    "direction": "incoming",
    "providerMessageId": "<string>",
    "providerName": "<string>",
    "threadId": "<string>",
    "text": "<string>",
    "action": "<string>",
    "importance": "<string>",
    "status": "<string>",
    "summary": "<string>",
    "urgency": "<string>",
    "sender": "<unknown>",
    "recipient": "<unknown>",
    "category": "<unknown>",
    "metadata": "<unknown>"
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Path Parameters

id
string<uuid>
required

Message UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
readAt
string<date-time> · null · null
Example:

"2024-01-15T10:30:00Z"

archivedAt
string<date-time> · null · null
Example:

"2024-01-15T12:00:00Z"

snoozedUntil
string<date-time> · null · null
Example:

"2024-01-16T09:00:00Z"

Response

Message updated successfully

data
object
required
meta
object