Skip to main content

ConversationDetail

idstring
phoneNumberIdstring
statusstring

Possible values: [open, pending, closed, snoozed]

assignedUserIdstringnullable
assignee objectnullable
idstring
namestring
snoozedUntilstring<date-time>nullable
lastMessageAtstring<date-time>nullable
lastMessagePreviewstringnullable
lastInboundAtstring<date-time>nullable
windowExpiresAtstring<date-time>nullable

Until when free-form replies are possible: 24 hours after the customer's last message (72 hours for conversations from an ad).

windowOpenboolean
unreadCountinteger
awaitingSincestring<date-time>nullable

Since when the customer has been waiting for the team.

automationPausedUntilstring<date-time>nullable
firstResponseAtstring<date-time>nullable
closedAtstring<date-time>nullable
contact object
idstring
phonestringnullable

E.164 without the +.

Example: 5541987111527
countrystringnullable
Example: BR
waIdstringnullable
bsuidstringnullable
usernamestringnullable
profileNamestringnullable
firstNamestringnullable
lastNamestringnullable
namestringnullable

First and last name, or the WhatsApp profile name when there is no name.

emailstringnullable
localestringnullable
timezonestringnullable
attributes object

Custom field values, keyed by the field key.

property name*any

Custom field values, keyed by the field key.

sourcestring

Possible values: [manual, import, api, inbound, flow]

optInStatusstring

Possible values: [opted_in, opted_out, unknown]

optInAtstring<date-time>nullable
optInSourcestringnullable

Possible values: [import, api, form, keyword, flow, manual]

optInEvidencestringnullable
optOutAtstring<date-time>nullable
optOutSourcestringnullable

Possible values: [keyword, button, meta_131050, manual, api, flow]

optOutReasonstringnullable
tags object[]
  • Array [
  • idstring
    namestring
    colorstringnullable
  • ]
  • lastInboundAtstring<date-time>nullable
    lastOutboundAtstring<date-time>nullable
    lastCampaignAtstring<date-time>nullable
    createdAtstring<date-time>
    updatedAtstring<date-time>
    campaigns object[]

    Possible values: <= 5

  • Array [
  • idstring
    namestring
    statusstring
    sentAtstring<date-time>nullable
    readAtstring<date-time>nullable
    repliedAtstring<date-time>nullable
    clickedAtstring<date-time>nullable
  • ]
  • ConversationDetail
    {
    "id": "string",
    "phoneNumberId": "string",
    "status": "open",
    "assignedUserId": "string",
    "assignee": {
    "id": "string",
    "name": "string"
    },
    "snoozedUntil": "2024-07-29T15:51:28.071Z",
    "lastMessageAt": "2024-07-29T15:51:28.071Z",
    "lastMessagePreview": "string",
    "lastInboundAt": "2024-07-29T15:51:28.071Z",
    "windowExpiresAt": "2024-07-29T15:51:28.071Z",
    "windowOpen": true,
    "unreadCount": 0,
    "awaitingSince": "2024-07-29T15:51:28.071Z",
    "automationPausedUntil": "2024-07-29T15:51:28.071Z",
    "firstResponseAt": "2024-07-29T15:51:28.071Z",
    "closedAt": "2024-07-29T15:51:28.071Z",
    "contact": {
    "id": "string",
    "phone": "5541987111527",
    "country": "BR",
    "waId": "string",
    "bsuid": "string",
    "username": "string",
    "profileName": "string",
    "firstName": "string",
    "lastName": "string",
    "name": "string",
    "email": "string",
    "locale": "string",
    "timezone": "string",
    "attributes": {},
    "source": "manual",
    "optInStatus": "opted_in",
    "optInAt": "2024-07-29T15:51:28.071Z",
    "optInSource": "import",
    "optInEvidence": "string",
    "optOutAt": "2024-07-29T15:51:28.071Z",
    "optOutSource": "keyword",
    "optOutReason": "string",
    "tags": [
    {
    "id": "string",
    "name": "string",
    "color": "string"
    }
    ],
    "lastInboundAt": "2024-07-29T15:51:28.071Z",
    "lastOutboundAt": "2024-07-29T15:51:28.071Z",
    "lastCampaignAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    },
    "campaigns": [
    {
    "id": "string",
    "name": "string",
    "status": "string",
    "sentAt": "2024-07-29T15:51:28.071Z",
    "readAt": "2024-07-29T15:51:28.071Z",
    "repliedAt": "2024-07-29T15:51:28.071Z",
    "clickedAt": "2024-07-29T15:51:28.071Z"
    }
    ]
    }