REST API reference
Browse every released operation generated from the V Chat OpenAPI contract.
Generated contract source
Every operation page below is generated from the checked-in OpenAPI artifact. Dedicated endpoint folders remain the authority for authorization, validation, consistency, idempotency, event side effects, retries, and frontend reconciliation.
Operations
139 of 139 operations
GETList the current app user device registrations
/v1/app-user/device-registrationslistCurrentAppUserDeviceRegistrationsPOSTRevoke the current app user device registration/v1/app-user/device-registrations/{registrationId}/revokerevokeCurrentAppUserDeviceRegistrationPUTCreate or replace the current app user device registration/v1/app-user/device-registrations/installations/{installationId}upsertCurrentAppUserDeviceRegistrationGETGet the current app user push preferences/v1/app-user/push-preferencesgetCurrentAppUserPushPreferencesPUTReplace the current app user push preferences/v1/app-user/push-preferencesupdateCurrentAppUserPushPreferencesGETRead the current app-user session/v1/app-user/sessiongetCurrentAppUserSessionPOSTIssue an app-user bearer token/v1/app-user-tokensissueAppUserTokenPOSTRevoke all tokens for an app user/v1/app-users/{userId}/tokens/revokerevokeAppUserTokensPOSTDeactivate an app user/v1/app-users/{userId}/deactivatedeactivateAppUserGETGet an app user/v1/app-users/{userId}getAppUserPOSTQuery app users/v1/app-users/queryqueryAppUsersPOSTReactivate an app user/v1/app-users/{userId}/reactivatereactivateAppUserPOSTSearch app users by literal text/v1/app-users/searchsearchAppUsersPUTCreate or update an app user/v1/app-users/{userId}upsertAppUserPOSTIssue an app server credential/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/credentialsissueAppCredentialGETList app credential metadata/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/credentialslistAppCredentialsPOSTRevoke an app credential/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/credentials/{credentialId}/revokerevokeAppCredentialPOSTRotate an app credential/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/credentials/{credentialId}/rotaterotateAppCredentialPOSTCreate an application/v1/organizations/{organizationId}/applicationscreateApplicationGETGet an application/v1/organizations/{organizationId}/applications/{applicationId}getApplicationGETList fixed application environments/v1/organizations/{organizationId}/applications/{applicationId}/environmentslistApplicationEnvironmentsGETList organization applications/v1/organizations/{organizationId}/applicationslistApplicationsPATCHUpdate fixed environment settings/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/settingsupdateApplicationEnvironmentSettingsPATCHUpdate application settings/v1/organizations/{organizationId}/applications/{applicationId}/settingsupdateApplicationSettingsPOSTVerify and scan an upload/v1/attachments/{attachmentId}/completecompleteAttachmentUploadPOSTMint a short-lived attachment download target/v1/attachments/{attachmentId}/download-urlcreateAttachmentDownloadUrlPOSTCreate or replay an attachment upload intent/v1/attachments/upload-intentscreateAttachmentUploadIntentDELETEDelete an owned attachment/v1/attachments/{attachmentId}deleteAttachmentGETGet owned attachment metadata/v1/attachments/{attachmentId}getAttachmentPUTAdd or reactivate one channel member/v1/channels/{channelTypeKey}/{channelId}/members/{userId}addChannelMemberGETGet one retained channel membership/v1/channels/{channelTypeKey}/{channelId}/members/{userId}getChannelMemberDELETERemove one channel member/v1/channels/{channelTypeKey}/{channelId}/members/{userId}removeChannelMemberPATCHReplace channel membership custom data/v1/channels/{channelTypeKey}/{channelId}/members/{userId}updateChannelMemberPOSTCreate a channel type/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-typescreateChannelTypePOSTDeactivate a channel type/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-types/{channelTypeKey}/deactivatedeactivateChannelTypeGETGet a channel type/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-types/{channelTypeKey}getChannelTypeGETList channel types/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-typeslistChannelTypesPOSTReactivate a channel type/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-types/{channelTypeKey}/reactivatereactivateChannelTypePUTReplace a channel type/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/channel-types/{channelTypeKey}replaceChannelTypePUTCreate a channel by natural identity/v1/channels/{channelTypeKey}/{channelId}createChannelGETGet a channel by natural identity/v1/channels/{channelTypeKey}/{channelId}getChannelPOSTQuery channels for one channel type/v1/channels/queryqueryChannelsPOSTSearch channels by literal text/v1/channels/searchsearchChannelsPATCHUpdate mutable channel metadata/v1/channels/{channelTypeKey}/{channelId}updateChannelGETRead the current app-user unread summary/v1/app-user/unreadgetCurrentAppUserUnreadSummaryPUTAdvance the current app-user channel read horizon/v1/channels/{channelTypeKey}/{channelId}/read-statemarkChannelReadPOSTQuery the current app-user conversation list/v1/app-user/conversations/queryqueryCurrentAppUserConversationsDELETECancel a current app-user privacy job/v1/app-user/data-jobs/{jobId}cancelCurrentAppUserDataLifecycleJobPOSTCreate a current app-user export download URL/v1/app-user/data-jobs/{jobId}/downloadcreateCurrentAppUserDataExportDownloadUrlPUTCreate a current app-user privacy job/v1/app-user/data-jobs/{jobId}createCurrentAppUserDataLifecycleJobGETGet a current app-user privacy job/v1/app-user/data-jobs/{jobId}getCurrentAppUserDataLifecycleJobGETBegin dashboard OIDC login/v1/dashboard/auth/loginbeginDashboardLoginGETBegin fresh dashboard reauthentication/v1/dashboard/auth/reauthenticatebeginDashboardReauthenticationGETComplete dashboard OIDC login/v1/dashboard/auth/callbackcompleteDashboardLoginDELETEEnd the current dashboard session/v1/dashboard/sessionendDashboardSessionGETGet the dashboard principal/v1/dashboard/sessiongetDashboardSessionDELETERevoke every dashboard session for the current account/v1/dashboard/sessionsrevokeDashboardSessionsPOSTReceive a signed dashboard identity-provider lifecycle event/v1/integrations/oidc/dashboard-eventsreceiveDashboardIdentityProviderEventDELETECancel a data job/v1/organizations/{organizationId}/applications/{applicationId}/data-jobs/{jobId}cancelDataLifecycleJobPOSTCreate a short-lived export download URL/v1/organizations/{organizationId}/applications/{applicationId}/data-jobs/{jobId}/downloadcreateDataExportDownloadUrlPUTCreate a data job/v1/organizations/{organizationId}/applications/{applicationId}/data-jobs/{jobId}createDataLifecycleJobGETGet a data job/v1/organizations/{organizationId}/applications/{applicationId}/data-jobs/{jobId}getDataLifecycleJobGETGet a retention policy/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/retention-policygetDataRetentionPolicyPUTReplace a retention policy/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/retention-policyupdateDataRetentionPolicyGETCheck required API dependency readiness/v1/health/readinessgetReadinessPUTAdd or reactivate the authenticated app user reaction/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}/reactions/{reactionType}addMessageReactionDELETEIrreversibly redact a message/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}deleteMessageGETGet one message or tombstone/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}getMessageGETRead one root and a reply page/v1/channels/{channelTypeKey}/{channelId}/messages/{rootMessageId}/threadgetMessageThreadGETList active reactors for one reaction type/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}/reactions/{reactionType}listMessageReactionUsersPUTAdvance the current app-user thread read horizon/v1/channels/{channelTypeKey}/{channelId}/messages/{rootMessageId}/thread/read-statemarkMessageThreadReadGETQuery older channel messages/v1/channels/{channelTypeKey}/{channelId}/messagesqueryMessagesDELETERemove the authenticated app user reaction/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}/reactions/{reactionType}removeMessageReactionPOSTSearch active messages in one channel/v1/channels/{channelTypeKey}/{channelId}/messages/searchsearchChannelMessagesPUTSend a top-level message by fixed identity/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}sendMessagePUTSend a direct reply by fixed identity/v1/channels/{channelTypeKey}/{channelId}/messages/{rootMessageId}/replies/{replyMessageId}sendMessageReplyPATCHUpdate owned message content/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}updateMessageDELETE/v1/moderation/bans/{userId}deleteAppUserBanDELETE/v1/moderation/blocklists/{blocklistKey}deleteModerationBlocklistDELETE/v1/moderation/me/relationships/{relationshipType}/{targetUserId}deleteMyModerationRelationshipPOST/v1/app-users/{userId}/moderation-flagsflagAppUserPOST/v1/channels/{channelTypeKey}/{channelId}/messages/{messageId}/moderation-flagsflagMessageGET/v1/moderation/blocklists/{blocklistKey}getModerationBlocklistGET/v1/moderation/cases/{caseId}getModerationCasePUT/v1/moderation/bans/{userId}putAppUserBanPUT/v1/moderation/blocklists/{blocklistKey}putModerationBlocklistPUT/v1/moderation/cases/{caseId}/resolutionputModerationCaseResolutionPUT/v1/moderation/me/relationships/{relationshipType}/{targetUserId}putMyModerationRelationshipGET/v1/moderation/bansqueryAppUserBansGET/v1/moderation/blocklistsqueryModerationBlocklistsGET/v1/moderation/casesqueryModerationCasesGET/v1/moderation/me/relationshipsqueryMyModerationRelationshipsGETGet an organization audit event/v1/organizations/{organizationId}/audit-events/{auditEventId}getOrganizationAuditEventGETList organization audit events/v1/organizations/{organizationId}/audit-eventslistOrganizationAuditEventsPOSTAccept an invitation targeting my dashboard account/v1/organization-invitations/{invitationId}/acceptacceptOrganizationInvitationPOSTDecline an invitation targeting my dashboard account/v1/organization-invitations/{invitationId}/declinedeclineOrganizationInvitationGETList invitations targeting my dashboard account/v1/organization-invitationslistMyOrganizationInvitationsPUTAdd an organization member/v1/organizations/{organizationId}/memberships/{accountId}addOrganizationMemberPOSTCreate an organization/v1/organizationscreateOrganizationPOSTCreate an account-bound organization invitation/v1/organizations/{organizationId}/invitationscreateOrganizationInvitationGETGet my effective organization authorization/v1/organizations/{organizationId}/authorizationgetMyOrganizationAuthorizationGETGet an organization/v1/organizations/{organizationId}getOrganizationGETList my organizations/v1/organizationslistMyOrganizationsGETList pending organization invitations/v1/organizations/{organizationId}/invitationslistOrganizationInvitationsGETList active organization memberships/v1/organizations/{organizationId}/membershipslistOrganizationMembershipsGETList built-in organization roles and capabilities/v1/organizations/{organizationId}/roleslistOrganizationRolesDELETERemove an organization member/v1/organizations/{organizationId}/memberships/{accountId}removeOrganizationMemberDELETERevoke a pending organization invitation/v1/organizations/{organizationId}/invitations/{invitationId}revokeOrganizationInvitationPUTUpdate an active non-owner organization membership role/v1/organizations/{organizationId}/memberships/{accountId}/roleupdateOrganizationMemberRolePOSTCreate a one-use realtime connection ticket/v1/realtime/connection-ticketscreateRealtimeConnectionTicketPOSTDeactivate a support app user/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/{userId}/deactivatedeactivateSupportAppUserGETGet a support app user/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/{userId}getSupportAppUserGETInspect durable app-user messaging state/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/app-users/{userId}/messaging-inspectorgetSupportAppUserMessagingInspectorGETGet a support channel/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/channels/{channelTypeKey}/{channelId}getSupportChannelGETInspect durable channel realtime state/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/channels/{channelTypeKey}/{channelId}/realtime-inspectorgetSupportChannelRealtimeInspectorGETGet safe realtime configuration/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/realtime/configurationgetSupportRealtimeConfigurationGETList redacted support devices/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/app-users/{userId}/device-registrationslistSupportAppUserDeviceRegistrationsPOSTQuery support app users/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/queryquerySupportAppUsersPOSTQuery support channel members/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/channels/{channelTypeKey}/{channelId}/members/queryquerySupportChannelMembersPOSTQuery support channels/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/channels/queryquerySupportChannelsGETQuery support messages/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/channels/{channelTypeKey}/{channelId}/messagesquerySupportMessagesPOSTReactivate a support app user/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/{userId}/reactivatereactivateSupportAppUserPOSTRevoke an exact support device/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/support/app-users/{userId}/device-registrations/{registrationId}/revokerevokeSupportAppUserDeviceRegistrationPOSTRevoke support app-user tokens/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/{userId}/tokens/revokerevokeSupportAppUserTokensPUTCreate or update a support app user/v1/organizations/{organizationId}/applications/{applicationId}/support/app-users/{userId}upsertSupportAppUserGET/v1/organizations/{organizationId}/applications/{applicationId}/usage/summarygetApplicationUsageSummaryGET/v1/organizations/{organizationId}/applications/{applicationId}/usage/dailyqueryApplicationDailyUsagePOSTCreate a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpointscreateWebhookEndpointPOSTDeactivate a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/deactivatedeactivateWebhookEndpointDELETEDelete a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}deleteWebhookEndpointGETGet webhook delivery metadata/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/deliveries/{deliveryId}getWebhookDeliveryGETGet a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}getWebhookEndpointGETList webhook delivery metadata/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/deliverieslistWebhookDeliveriesGETList signed webhook endpoints/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpointslistWebhookEndpointsPOSTReactivate a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/reactivatereactivateWebhookEndpointPOSTQueue one webhook delivery replay/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/replayreplayWebhookDeliveryPOSTRotate a webhook signing secret/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/secret/rotaterotateWebhookEndpointSecretPOSTQueue a synthetic webhook test/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}/testsendWebhookEndpointTestPATCHUpdate a signed webhook endpoint/v1/organizations/{organizationId}/applications/{applicationId}/environments/{environmentKey}/webhook-endpoints/{endpointId}updateWebhookEndpoint