object
Window
Tells a client whether the current actor can send in this conversation right now.
Properties
- Name
state- Type
- enum
- Description
- Required property. Allowed values: OPEN, CLOSED.
- Name
forActor- Type
- enum
- Description
- Required property. Allowed values: AGENT, BOT.
- Name
expiresAt- Type
- string
- Description
- Optional property.
- Name
failureCode- Type
- enum
- Description
- Public reason code when this actor cannot send in the current window. Allowed values: messagingWindowClosed, inboxRequired, unsupportedChannel.
Related operations
- Send a messagePOST /messages
- Get messageGET /messages/{id}
- Upload message mediaPOST /media/uploads
- List conversationsGET /conversations
- Get conversationGET /conversations/{id}
- List conversation messagesGET /conversations/{id}/messages
- Send message in a conversationPOST /conversations/{id}/messages
- Add or remove a reaction on a messagePOST /messages/{id}/reactions
- Reassign conversationPOST /conversations/{id}/reassign
- Mark conversation as readPOST /conversations/{id}/read
- Close conversationPOST /conversations/{id}/close
- Get inboxesGET /inboxes
- Create inboxPOST /inboxes
- Delete inboxDELETE /inboxes/{id}
- Assign team to inboxPUT /inboxes/{id}/team
- Clear team from inboxDELETE /inboxes/{id}/team
- List WhatsApp templatesGET /inboxes/{id}/whatsapp/templates
- List WABA phone numbersGET /whatsapp/{wabaId}/phone-numbers
- Get contactsGET /contacts
- Create contactPOST /contacts
- Count contactsGET /contacts/count
- Get contact by IDGET /contacts/{id}
- Update contactPATCH /contacts/{id}
- Delete contactDELETE /contacts/{id}
- Import contacts from CSVPOST /contacts/import
- Get import statusGET /contacts/imports/{id}
- Archive contactPOST /contacts/{id}/archive
- Unarchive contactPOST /contacts/{id}/unarchive
- Set contact field valuePUT /contacts/{contactId}/custom-fields/{customFieldId}
- Add tag to contactPOST /contacts/{contactId}/tags/{tagId}
- Remove tag from contactDELETE /contacts/{contactId}/tags/{tagId}
- List tagsGET /tags
- Create tagPOST /tags
- Delete tagDELETE /tags/{id}
- List contact field definitionsGET /contacts/custom-fields
- Create contact field definitionPOST /contacts/custom-fields
- Update contact field definitionPATCH /contacts/custom-fields/{id}
- Delete contact field definitionDELETE /contacts/custom-fields/{id}
- List property field definitionsGET /properties/custom-fields
- Create property field definitionPOST /properties/custom-fields
- Update property field definitionPATCH /properties/custom-fields/{id}
- Delete property field definitionDELETE /properties/custom-fields/{id}
- List journeysGET /journeys
- Create journeyPOST /journeys
- Get journeyGET /journeys/{id}
- Update journeyPATCH /journeys/{id}
- Delete journeyDELETE /journeys/{id}
- Publish journeyPOST /journeys/{id}/publish
- Activate journeyPOST /journeys/{id}/activate
- Pause journeyPOST /journeys/{id}/pause
- List journey versionsGET /journeys/{id}/versions
- Get journey versionGET /journeys/versions/{versionId}
- List chatbotsGET /chatbots
- Create chatbotPOST /chatbots
- Get chatbotGET /chatbots/{id}
- Update chatbotPATCH /chatbots/{id}
- Delete chatbotDELETE /chatbots/{id}
- Publish chatbotPOST /chatbots/{id}/publish
- Activate chatbotPOST /chatbots/{id}/activate
- Pause chatbotPOST /chatbots/{id}/pause
- List chatbot versionsGET /chatbots/{id}/versions
- Get chatbot versionGET /chatbots/{id}/versions/{versionId}
- List event typesGET /event-types
- Create event typePOST /event-types
- Get event typeGET /event-types/{id}
- Update event typePATCH /event-types/{id}
- Delete event typeDELETE /event-types/{id}
- List eventsGET /events
- Create eventPOST /events
- Get eventGET /events/{id}
- List events by contactGET /contacts/{contactId}/events
- Create event for contactPOST /contacts/{contactId}/events
- List teamsGET /teams
- Create teamPOST /teams
- Get teamGET /teams/{id}
- Update teamPUT /teams/{id}
- Delete teamDELETE /teams/{id}
- List team agentsGET /teams/{id}/agents
- Add agent to teamPOST /teams/{id}/agents
- Remove agent from teamDELETE /teams/{id}/agents/{userId}
- Get usersGET /users
- Get current user profileGET /users/me
- Update current user profilePATCH /users/me
- Get current user's global unread message countGET /users/me/unread-count
- Authoritative unread summary with monotonic versionGET /users/me/unread-summary
- Get userGET /users/{userId}
- Update a member's rolePUT /users/{userId}/role
- Get billing statusGET /billing/status
- List service accountsGET /service-accounts
- Create service accountPOST /service-accounts
- Delete service accountDELETE /service-accounts/{id}
- List API keys for a service accountGET /service-accounts/{id}/api-keys
- Create API keyPOST /service-accounts/{id}/api-keys
- Revoke API keyDELETE /api-keys/{id}
- Get webhook settingsGET /webhooks
- Update webhook settingsPATCH /webhooks
- Delete webhook settingsDELETE /webhooks
- Verify webhook deliveryPOST /webhooks/verify
- List webhook delivery attemptsGET /webhooks/attempts
- List webhook signing keys for the current tenantGET /webhooks/signing-keys
- Rotate the webhook signing keyPOST /webhooks/signing-keys/rotate