openapi: '3.0.3'
info:
title: Backbone API
version: '1.0.0'
description: |
Auto-generated by backbone-cli.
This API provides 11 standard CRUD endpoints for each model.
servers:
- url: /
description: Development server
tags:
- name: MailActivities
description: MailActivity management endpoints
- name: MailActivityTypes
description: MailActivityType management endpoints
- name: MailActivityPlans
description: MailActivityPlan management endpoints
- name: MailActivityPlanTemplates
description: MailActivityPlanTemplate management endpoints
- name: MailAliasDomains
description: MailAliasDomain management endpoints
- name: MailAliases
description: MailAlias management endpoints
- name: MailAttachments
description: MailAttachment management endpoints
- name: MailMessageAttachments
description: MailMessageAttachment management endpoints
- name: MailMessageStars
description: MailMessageStar management endpoints
- name: MailMessages
description: MailMessage management endpoints
- name: Mails
description: Mail management endpoints
- name: MailNotifications
description: MailNotification management endpoints
- name: MailMessageSubtypes
description: MailMessageSubtype management endpoints
- name: MailMessageReactions
description: MailMessageReaction management endpoints
- name: MailFollowerses
description: MailFollowers management endpoints
- name: MailPresences
description: MailPresence management endpoints
- name: MailBlacklists
description: MailBlacklist management endpoints
- name: MailTrackingValues
description: MailTrackingValue management endpoints
- name: DiscussChannels
description: DiscussChannel management endpoints
- name: DiscussChannelMembers
description: DiscussChannelMember management endpoints
- name: MailGuests
description: MailGuest management endpoints
- name: MailServers
description: MailServer management endpoints
- name: FetchmailServers
description: FetchmailServer management endpoints
- name: MailGatewayAlloweds
description: MailGatewayAllowed management endpoints
- name: PhoneBlacklists
description: PhoneBlacklist management endpoints
- name: MailMessageSchedules
description: MailMessageSchedule management endpoints
- name: MailScheduledMessages
description: MailScheduledMessage management endpoints
- name: Smses
description: Sms management endpoints
- name: SmsTemplates
description: SmsTemplate management endpoints
- name: SmsTrackers
description: SmsTracker management endpoints
paths:
/api/v1/messaging/mail_activities:
get:
tags:
- MailActivities
summary: List MailActivities
description: Get a paginated list of MailActivities with optional filtering and sorting
operationId: listMailActivities
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailActivities
summary: Create MailActivity
description: Create a new MailActivity
operationId: createMailActivity
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailActivityRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_activities/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailActivities
summary: Get MailActivity by ID
operationId: getMailActivity
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailActivities
summary: Update MailActivity (full)
operationId: updateMailActivity
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailActivities
summary: Update MailActivity (partial)
operationId: patchMailActivity
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailActivityRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailActivities
summary: Delete MailActivity (soft)
operationId: deleteMailActivity
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activities/bulk:
post:
tags:
- MailActivities
summary: Bulk create MailActivities
operationId: bulkCreateMailActivities
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailActivityRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailActivity'
put:
tags:
- MailActivities
summary: Bulk update MailActivities (full, atomic)
operationId: bulkUpdateMailActivities
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailActivityRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailActivities
summary: Bulk partial-update MailActivities (atomic)
operationId: bulkPatchMailActivities
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activities/upsert:
post:
tags:
- MailActivities
summary: Upsert MailActivity
operationId: upsertMailActivity
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
/api/v1/messaging/mail_activities/trash:
get:
tags:
- MailActivities
summary: List deleted MailActivities
operationId: listDeletedMailActivities
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityList'
/api/v1/messaging/mail_activities/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailActivities
summary: Restore deleted MailActivity
operationId: restoreMailActivity
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivity'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activities/empty:
delete:
tags:
- MailActivities
summary: Empty trash for MailActivities
operationId: emptyTrashMailActivities
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_activities/delete/bulk:
post:
tags:
- MailActivities
summary: Bulk soft-delete MailActivities by ids (atomic)
operationId: bulkDeleteMailActivities
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activities/restore/bulk:
post:
tags:
- MailActivities
summary: Bulk restore MailActivities by ids (atomic)
operationId: bulkRestoreMailActivities
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activities/restore/all:
post:
tags:
- MailActivities
summary: Restore all soft-deleted MailActivities
operationId: restoreAllMailActivities
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_activities/trash/bulk:
delete:
tags:
- MailActivities
summary: Bulk permanently-delete MailActivities from trash by ids (atomic)
operationId: bulkPermanentDeleteMailActivities
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_types:
get:
tags:
- MailActivityTypes
summary: List MailActivityTypes
description: Get a paginated list of MailActivityTypes with optional filtering and sorting
operationId: listMailActivityTypes
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityTypeList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailActivityTypes
summary: Create MailActivityType
description: Create a new MailActivityType
operationId: createMailActivityType
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailActivityTypeRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_activity_types/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailActivityTypes
summary: Get MailActivityType by ID
operationId: getMailActivityType
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailActivityTypes
summary: Update MailActivityType (full)
operationId: updateMailActivityType
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityTypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailActivityTypes
summary: Update MailActivityType (partial)
operationId: patchMailActivityType
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailActivityTypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailActivityTypes
summary: Delete MailActivityType (soft)
operationId: deleteMailActivityType
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_types/bulk:
post:
tags:
- MailActivityTypes
summary: Bulk create MailActivityTypes
operationId: bulkCreateMailActivityTypes
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailActivityTypeRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailActivityType'
put:
tags:
- MailActivityTypes
summary: Bulk update MailActivityTypes (full, atomic)
operationId: bulkUpdateMailActivityTypes
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailActivityTypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityTypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailActivityTypes
summary: Bulk partial-update MailActivityTypes (atomic)
operationId: bulkPatchMailActivityTypes
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityTypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_types/upsert:
post:
tags:
- MailActivityTypes
summary: Upsert MailActivityType
operationId: upsertMailActivityType
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityTypeRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
/api/v1/messaging/mail_activity_types/trash:
get:
tags:
- MailActivityTypes
summary: List deleted MailActivityTypes
operationId: listDeletedMailActivityTypes
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityTypeList'
/api/v1/messaging/mail_activity_types/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailActivityTypes
summary: Restore deleted MailActivityType
operationId: restoreMailActivityType
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityType'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_types/empty:
delete:
tags:
- MailActivityTypes
summary: Empty trash for MailActivityTypes
operationId: emptyTrashMailActivityTypes
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_activity_types/delete/bulk:
post:
tags:
- MailActivityTypes
summary: Bulk soft-delete MailActivityTypes by ids (atomic)
operationId: bulkDeleteMailActivityTypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_types/restore/bulk:
post:
tags:
- MailActivityTypes
summary: Bulk restore MailActivityTypes by ids (atomic)
operationId: bulkRestoreMailActivityTypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityTypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_types/restore/all:
post:
tags:
- MailActivityTypes
summary: Restore all soft-deleted MailActivityTypes
operationId: restoreAllMailActivityTypes
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_activity_types/trash/bulk:
delete:
tags:
- MailActivityTypes
summary: Bulk permanently-delete MailActivityTypes from trash by ids (atomic)
operationId: bulkPermanentDeleteMailActivityTypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plans:
get:
tags:
- MailActivityPlans
summary: List MailActivityPlans
description: Get a paginated list of MailActivityPlans with optional filtering and sorting
operationId: listMailActivityPlans
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailActivityPlans
summary: Create MailActivityPlan
description: Create a new MailActivityPlan
operationId: createMailActivityPlan
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailActivityPlanRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_activity_plans/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailActivityPlans
summary: Get MailActivityPlan by ID
operationId: getMailActivityPlan
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailActivityPlans
summary: Update MailActivityPlan (full)
operationId: updateMailActivityPlan
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityPlanRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailActivityPlans
summary: Update MailActivityPlan (partial)
operationId: patchMailActivityPlan
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailActivityPlanRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailActivityPlans
summary: Delete MailActivityPlan (soft)
operationId: deleteMailActivityPlan
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_plans/bulk:
post:
tags:
- MailActivityPlans
summary: Bulk create MailActivityPlans
operationId: bulkCreateMailActivityPlans
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailActivityPlanRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailActivityPlan'
put:
tags:
- MailActivityPlans
summary: Bulk update MailActivityPlans (full, atomic)
operationId: bulkUpdateMailActivityPlans
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailActivityPlanRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailActivityPlans
summary: Bulk partial-update MailActivityPlans (atomic)
operationId: bulkPatchMailActivityPlans
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plans/upsert:
post:
tags:
- MailActivityPlans
summary: Upsert MailActivityPlan
operationId: upsertMailActivityPlan
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityPlanRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
/api/v1/messaging/mail_activity_plans/trash:
get:
tags:
- MailActivityPlans
summary: List deleted MailActivityPlans
operationId: listDeletedMailActivityPlans
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanList'
/api/v1/messaging/mail_activity_plans/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailActivityPlans
summary: Restore deleted MailActivityPlan
operationId: restoreMailActivityPlan
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlan'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_plans/empty:
delete:
tags:
- MailActivityPlans
summary: Empty trash for MailActivityPlans
operationId: emptyTrashMailActivityPlans
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_activity_plans/delete/bulk:
post:
tags:
- MailActivityPlans
summary: Bulk soft-delete MailActivityPlans by ids (atomic)
operationId: bulkDeleteMailActivityPlans
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plans/restore/bulk:
post:
tags:
- MailActivityPlans
summary: Bulk restore MailActivityPlans by ids (atomic)
operationId: bulkRestoreMailActivityPlans
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plans/restore/all:
post:
tags:
- MailActivityPlans
summary: Restore all soft-deleted MailActivityPlans
operationId: restoreAllMailActivityPlans
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_activity_plans/trash/bulk:
delete:
tags:
- MailActivityPlans
summary: Bulk permanently-delete MailActivityPlans from trash by ids (atomic)
operationId: bulkPermanentDeleteMailActivityPlans
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plan_templates:
get:
tags:
- MailActivityPlanTemplates
summary: List MailActivityPlanTemplates
description: Get a paginated list of MailActivityPlanTemplates with optional filtering and sorting
operationId: listMailActivityPlanTemplates
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplateList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailActivityPlanTemplates
summary: Create MailActivityPlanTemplate
description: Create a new MailActivityPlanTemplate
operationId: createMailActivityPlanTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailActivityPlanTemplateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_activity_plan_templates/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailActivityPlanTemplates
summary: Get MailActivityPlanTemplate by ID
operationId: getMailActivityPlanTemplate
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailActivityPlanTemplates
summary: Update MailActivityPlanTemplate (full)
operationId: updateMailActivityPlanTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityPlanTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailActivityPlanTemplates
summary: Update MailActivityPlanTemplate (partial)
operationId: patchMailActivityPlanTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailActivityPlanTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailActivityPlanTemplates
summary: Delete MailActivityPlanTemplate (soft)
operationId: deleteMailActivityPlanTemplate
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_plan_templates/bulk:
post:
tags:
- MailActivityPlanTemplates
summary: Bulk create MailActivityPlanTemplates
operationId: bulkCreateMailActivityPlanTemplates
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailActivityPlanTemplateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailActivityPlanTemplate'
put:
tags:
- MailActivityPlanTemplates
summary: Bulk update MailActivityPlanTemplates (full, atomic)
operationId: bulkUpdateMailActivityPlanTemplates
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailActivityPlanTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailActivityPlanTemplates
summary: Bulk partial-update MailActivityPlanTemplates (atomic)
operationId: bulkPatchMailActivityPlanTemplates
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plan_templates/upsert:
post:
tags:
- MailActivityPlanTemplates
summary: Upsert MailActivityPlanTemplate
operationId: upsertMailActivityPlanTemplate
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailActivityPlanTemplateRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
/api/v1/messaging/mail_activity_plan_templates/trash:
get:
tags:
- MailActivityPlanTemplates
summary: List deleted MailActivityPlanTemplates
operationId: listDeletedMailActivityPlanTemplates
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplateList'
/api/v1/messaging/mail_activity_plan_templates/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailActivityPlanTemplates
summary: Restore deleted MailActivityPlanTemplate
operationId: restoreMailActivityPlanTemplate
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplate'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_activity_plan_templates/empty:
delete:
tags:
- MailActivityPlanTemplates
summary: Empty trash for MailActivityPlanTemplates
operationId: emptyTrashMailActivityPlanTemplates
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_activity_plan_templates/delete/bulk:
post:
tags:
- MailActivityPlanTemplates
summary: Bulk soft-delete MailActivityPlanTemplates by ids (atomic)
operationId: bulkDeleteMailActivityPlanTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plan_templates/restore/bulk:
post:
tags:
- MailActivityPlanTemplates
summary: Bulk restore MailActivityPlanTemplates by ids (atomic)
operationId: bulkRestoreMailActivityPlanTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailActivityPlanTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_activity_plan_templates/restore/all:
post:
tags:
- MailActivityPlanTemplates
summary: Restore all soft-deleted MailActivityPlanTemplates
operationId: restoreAllMailActivityPlanTemplates
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_activity_plan_templates/trash/bulk:
delete:
tags:
- MailActivityPlanTemplates
summary: Bulk permanently-delete MailActivityPlanTemplates from trash by ids (atomic)
operationId: bulkPermanentDeleteMailActivityPlanTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_alias_domains:
get:
tags:
- MailAliasDomains
summary: List MailAliasDomains
description: Get a paginated list of MailAliasDomains with optional filtering and sorting
operationId: listMailAliasDomains
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomainList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailAliasDomains
summary: Create MailAliasDomain
description: Create a new MailAliasDomain
operationId: createMailAliasDomain
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailAliasDomainRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_alias_domains/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailAliasDomains
summary: Get MailAliasDomain by ID
operationId: getMailAliasDomain
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailAliasDomains
summary: Update MailAliasDomain (full)
operationId: updateMailAliasDomain
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAliasDomainRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailAliasDomains
summary: Update MailAliasDomain (partial)
operationId: patchMailAliasDomain
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailAliasDomainRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailAliasDomains
summary: Delete MailAliasDomain (soft)
operationId: deleteMailAliasDomain
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_alias_domains/bulk:
post:
tags:
- MailAliasDomains
summary: Bulk create MailAliasDomains
operationId: bulkCreateMailAliasDomains
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailAliasDomainRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailAliasDomain'
put:
tags:
- MailAliasDomains
summary: Bulk update MailAliasDomains (full, atomic)
operationId: bulkUpdateMailAliasDomains
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailAliasDomainRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomainBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailAliasDomains
summary: Bulk partial-update MailAliasDomains (atomic)
operationId: bulkPatchMailAliasDomains
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomainBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_alias_domains/upsert:
post:
tags:
- MailAliasDomains
summary: Upsert MailAliasDomain
operationId: upsertMailAliasDomain
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAliasDomainRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
/api/v1/messaging/mail_alias_domains/trash:
get:
tags:
- MailAliasDomains
summary: List deleted MailAliasDomains
operationId: listDeletedMailAliasDomains
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomainList'
/api/v1/messaging/mail_alias_domains/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailAliasDomains
summary: Restore deleted MailAliasDomain
operationId: restoreMailAliasDomain
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomain'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_alias_domains/empty:
delete:
tags:
- MailAliasDomains
summary: Empty trash for MailAliasDomains
operationId: emptyTrashMailAliasDomains
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_alias_domains/delete/bulk:
post:
tags:
- MailAliasDomains
summary: Bulk soft-delete MailAliasDomains by ids (atomic)
operationId: bulkDeleteMailAliasDomains
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_alias_domains/restore/bulk:
post:
tags:
- MailAliasDomains
summary: Bulk restore MailAliasDomains by ids (atomic)
operationId: bulkRestoreMailAliasDomains
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasDomainBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_alias_domains/restore/all:
post:
tags:
- MailAliasDomains
summary: Restore all soft-deleted MailAliasDomains
operationId: restoreAllMailAliasDomains
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_alias_domains/trash/bulk:
delete:
tags:
- MailAliasDomains
summary: Bulk permanently-delete MailAliasDomains from trash by ids (atomic)
operationId: bulkPermanentDeleteMailAliasDomains
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_aliases:
get:
tags:
- MailAliases
summary: List MailAliases
description: Get a paginated list of MailAliases with optional filtering and sorting
operationId: listMailAliases
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailAliases
summary: Create MailAlias
description: Create a new MailAlias
operationId: createMailAlias
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailAliasRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_aliases/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailAliases
summary: Get MailAlias by ID
operationId: getMailAlias
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailAliases
summary: Update MailAlias (full)
operationId: updateMailAlias
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAliasRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailAliases
summary: Update MailAlias (partial)
operationId: patchMailAlias
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailAliasRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailAliases
summary: Delete MailAlias (soft)
operationId: deleteMailAlias
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_aliases/bulk:
post:
tags:
- MailAliases
summary: Bulk create MailAliases
operationId: bulkCreateMailAliases
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailAliasRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailAlias'
put:
tags:
- MailAliases
summary: Bulk update MailAliases (full, atomic)
operationId: bulkUpdateMailAliases
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailAliasRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailAliases
summary: Bulk partial-update MailAliases (atomic)
operationId: bulkPatchMailAliases
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_aliases/upsert:
post:
tags:
- MailAliases
summary: Upsert MailAlias
operationId: upsertMailAlias
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAliasRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
/api/v1/messaging/mail_aliases/trash:
get:
tags:
- MailAliases
summary: List deleted MailAliases
operationId: listDeletedMailAliases
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasList'
/api/v1/messaging/mail_aliases/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailAliases
summary: Restore deleted MailAlias
operationId: restoreMailAlias
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAlias'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_aliases/empty:
delete:
tags:
- MailAliases
summary: Empty trash for MailAliases
operationId: emptyTrashMailAliases
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_aliases/delete/bulk:
post:
tags:
- MailAliases
summary: Bulk soft-delete MailAliases by ids (atomic)
operationId: bulkDeleteMailAliases
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_aliases/restore/bulk:
post:
tags:
- MailAliases
summary: Bulk restore MailAliases by ids (atomic)
operationId: bulkRestoreMailAliases
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAliasBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_aliases/restore/all:
post:
tags:
- MailAliases
summary: Restore all soft-deleted MailAliases
operationId: restoreAllMailAliases
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_aliases/trash/bulk:
delete:
tags:
- MailAliases
summary: Bulk permanently-delete MailAliases from trash by ids (atomic)
operationId: bulkPermanentDeleteMailAliases
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_attachments:
get:
tags:
- MailAttachments
summary: List MailAttachments
description: Get a paginated list of MailAttachments with optional filtering and sorting
operationId: listMailAttachments
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachmentList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailAttachments
summary: Create MailAttachment
description: Create a new MailAttachment
operationId: createMailAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailAttachmentRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_attachments/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailAttachments
summary: Get MailAttachment by ID
operationId: getMailAttachment
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailAttachments
summary: Update MailAttachment (full)
operationId: updateMailAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailAttachments
summary: Update MailAttachment (partial)
operationId: patchMailAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailAttachments
summary: Delete MailAttachment (soft)
operationId: deleteMailAttachment
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_attachments/bulk:
post:
tags:
- MailAttachments
summary: Bulk create MailAttachments
operationId: bulkCreateMailAttachments
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailAttachmentRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailAttachment'
put:
tags:
- MailAttachments
summary: Bulk update MailAttachments (full, atomic)
operationId: bulkUpdateMailAttachments
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailAttachments
summary: Bulk partial-update MailAttachments (atomic)
operationId: bulkPatchMailAttachments
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_attachments/upsert:
post:
tags:
- MailAttachments
summary: Upsert MailAttachment
operationId: upsertMailAttachment
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailAttachmentRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
/api/v1/messaging/mail_attachments/trash:
get:
tags:
- MailAttachments
summary: List deleted MailAttachments
operationId: listDeletedMailAttachments
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachmentList'
/api/v1/messaging/mail_attachments/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailAttachments
summary: Restore deleted MailAttachment
operationId: restoreMailAttachment
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachment'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_attachments/empty:
delete:
tags:
- MailAttachments
summary: Empty trash for MailAttachments
operationId: emptyTrashMailAttachments
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_attachments/delete/bulk:
post:
tags:
- MailAttachments
summary: Bulk soft-delete MailAttachments by ids (atomic)
operationId: bulkDeleteMailAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_attachments/restore/bulk:
post:
tags:
- MailAttachments
summary: Bulk restore MailAttachments by ids (atomic)
operationId: bulkRestoreMailAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_attachments/restore/all:
post:
tags:
- MailAttachments
summary: Restore all soft-deleted MailAttachments
operationId: restoreAllMailAttachments
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_attachments/trash/bulk:
delete:
tags:
- MailAttachments
summary: Bulk permanently-delete MailAttachments from trash by ids (atomic)
operationId: bulkPermanentDeleteMailAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_attachments:
get:
tags:
- MailMessageAttachments
summary: List MailMessageAttachments
description: Get a paginated list of MailMessageAttachments with optional filtering and sorting
operationId: listMailMessageAttachments
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachmentList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessageAttachments
summary: Create MailMessageAttachment
description: Create a new MailMessageAttachment
operationId: createMailMessageAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageAttachmentRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_message_attachments/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessageAttachments
summary: Get MailMessageAttachment by ID
operationId: getMailMessageAttachment
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessageAttachments
summary: Update MailMessageAttachment (full)
operationId: updateMailMessageAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessageAttachments
summary: Update MailMessageAttachment (partial)
operationId: patchMailMessageAttachment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessageAttachments
summary: Delete MailMessageAttachment (soft)
operationId: deleteMailMessageAttachment
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_attachments/bulk:
post:
tags:
- MailMessageAttachments
summary: Bulk create MailMessageAttachments
operationId: bulkCreateMailMessageAttachments
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageAttachmentRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessageAttachment'
put:
tags:
- MailMessageAttachments
summary: Bulk update MailMessageAttachments (full, atomic)
operationId: bulkUpdateMailMessageAttachments
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageAttachmentRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessageAttachments
summary: Bulk partial-update MailMessageAttachments (atomic)
operationId: bulkPatchMailMessageAttachments
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_attachments/upsert:
post:
tags:
- MailMessageAttachments
summary: Upsert MailMessageAttachment
operationId: upsertMailMessageAttachment
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageAttachmentRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
/api/v1/messaging/mail_message_attachments/trash:
get:
tags:
- MailMessageAttachments
summary: List deleted MailMessageAttachments
operationId: listDeletedMailMessageAttachments
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachmentList'
/api/v1/messaging/mail_message_attachments/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessageAttachments
summary: Restore deleted MailMessageAttachment
operationId: restoreMailMessageAttachment
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachment'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_attachments/empty:
delete:
tags:
- MailMessageAttachments
summary: Empty trash for MailMessageAttachments
operationId: emptyTrashMailMessageAttachments
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_message_attachments/delete/bulk:
post:
tags:
- MailMessageAttachments
summary: Bulk soft-delete MailMessageAttachments by ids (atomic)
operationId: bulkDeleteMailMessageAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_attachments/restore/bulk:
post:
tags:
- MailMessageAttachments
summary: Bulk restore MailMessageAttachments by ids (atomic)
operationId: bulkRestoreMailMessageAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageAttachmentBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_attachments/restore/all:
post:
tags:
- MailMessageAttachments
summary: Restore all soft-deleted MailMessageAttachments
operationId: restoreAllMailMessageAttachments
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_message_attachments/trash/bulk:
delete:
tags:
- MailMessageAttachments
summary: Bulk permanently-delete MailMessageAttachments from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessageAttachments
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_stars:
get:
tags:
- MailMessageStars
summary: List MailMessageStars
description: Get a paginated list of MailMessageStars with optional filtering and sorting
operationId: listMailMessageStars
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStarList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessageStars
summary: Create MailMessageStar
description: Create a new MailMessageStar
operationId: createMailMessageStar
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageStarRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_message_stars/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessageStars
summary: Get MailMessageStar by ID
operationId: getMailMessageStar
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessageStars
summary: Update MailMessageStar (full)
operationId: updateMailMessageStar
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageStarRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessageStars
summary: Update MailMessageStar (partial)
operationId: patchMailMessageStar
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageStarRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessageStars
summary: Delete MailMessageStar (soft)
operationId: deleteMailMessageStar
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_stars/bulk:
post:
tags:
- MailMessageStars
summary: Bulk create MailMessageStars
operationId: bulkCreateMailMessageStars
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageStarRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessageStar'
put:
tags:
- MailMessageStars
summary: Bulk update MailMessageStars (full, atomic)
operationId: bulkUpdateMailMessageStars
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageStarRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStarBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessageStars
summary: Bulk partial-update MailMessageStars (atomic)
operationId: bulkPatchMailMessageStars
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStarBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_stars/upsert:
post:
tags:
- MailMessageStars
summary: Upsert MailMessageStar
operationId: upsertMailMessageStar
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageStarRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
/api/v1/messaging/mail_message_stars/trash:
get:
tags:
- MailMessageStars
summary: List deleted MailMessageStars
operationId: listDeletedMailMessageStars
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStarList'
/api/v1/messaging/mail_message_stars/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessageStars
summary: Restore deleted MailMessageStar
operationId: restoreMailMessageStar
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStar'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_stars/empty:
delete:
tags:
- MailMessageStars
summary: Empty trash for MailMessageStars
operationId: emptyTrashMailMessageStars
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_message_stars/delete/bulk:
post:
tags:
- MailMessageStars
summary: Bulk soft-delete MailMessageStars by ids (atomic)
operationId: bulkDeleteMailMessageStars
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_stars/restore/bulk:
post:
tags:
- MailMessageStars
summary: Bulk restore MailMessageStars by ids (atomic)
operationId: bulkRestoreMailMessageStars
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageStarBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_stars/restore/all:
post:
tags:
- MailMessageStars
summary: Restore all soft-deleted MailMessageStars
operationId: restoreAllMailMessageStars
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_message_stars/trash/bulk:
delete:
tags:
- MailMessageStars
summary: Bulk permanently-delete MailMessageStars from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessageStars
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_messages:
get:
tags:
- MailMessages
summary: List MailMessages
description: Get a paginated list of MailMessages with optional filtering and sorting
operationId: listMailMessages
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessages
summary: Create MailMessage
description: Create a new MailMessage
operationId: createMailMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_messages/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessages
summary: Get MailMessage by ID
operationId: getMailMessage
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessages
summary: Update MailMessage (full)
operationId: updateMailMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessages
summary: Update MailMessage (partial)
operationId: patchMailMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessages
summary: Delete MailMessage (soft)
operationId: deleteMailMessage
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_messages/bulk:
post:
tags:
- MailMessages
summary: Bulk create MailMessages
operationId: bulkCreateMailMessages
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessage'
put:
tags:
- MailMessages
summary: Bulk update MailMessages (full, atomic)
operationId: bulkUpdateMailMessages
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessages
summary: Bulk partial-update MailMessages (atomic)
operationId: bulkPatchMailMessages
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_messages/upsert:
post:
tags:
- MailMessages
summary: Upsert MailMessage
operationId: upsertMailMessage
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
/api/v1/messaging/mail_messages/trash:
get:
tags:
- MailMessages
summary: List deleted MailMessages
operationId: listDeletedMailMessages
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageList'
/api/v1/messaging/mail_messages/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessages
summary: Restore deleted MailMessage
operationId: restoreMailMessage
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessage'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_messages/empty:
delete:
tags:
- MailMessages
summary: Empty trash for MailMessages
operationId: emptyTrashMailMessages
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_messages/delete/bulk:
post:
tags:
- MailMessages
summary: Bulk soft-delete MailMessages by ids (atomic)
operationId: bulkDeleteMailMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_messages/restore/bulk:
post:
tags:
- MailMessages
summary: Bulk restore MailMessages by ids (atomic)
operationId: bulkRestoreMailMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_messages/restore/all:
post:
tags:
- MailMessages
summary: Restore all soft-deleted MailMessages
operationId: restoreAllMailMessages
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_messages/trash/bulk:
delete:
tags:
- MailMessages
summary: Bulk permanently-delete MailMessages from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mails:
get:
tags:
- Mails
summary: List Mails
description: Get a paginated list of Mails with optional filtering and sorting
operationId: listMails
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- Mails
summary: Create Mail
description: Create a new Mail
operationId: createMail
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mails/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- Mails
summary: Get Mail by ID
operationId: getMail
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- Mails
summary: Update Mail (full)
operationId: updateMail
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Mails
summary: Update Mail (partial)
operationId: patchMail
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Mails
summary: Delete Mail (soft)
operationId: deleteMail
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mails/bulk:
post:
tags:
- Mails
summary: Bulk create Mails
operationId: bulkCreateMails
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Mail'
put:
tags:
- Mails
summary: Bulk update Mails (full, atomic)
operationId: bulkUpdateMails
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- Mails
summary: Bulk partial-update Mails (atomic)
operationId: bulkPatchMails
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mails/upsert:
post:
tags:
- Mails
summary: Upsert Mail
operationId: upsertMail
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
/api/v1/messaging/mails/trash:
get:
tags:
- Mails
summary: List deleted Mails
operationId: listDeletedMails
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailList'
/api/v1/messaging/mails/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- Mails
summary: Restore deleted Mail
operationId: restoreMail
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/Mail'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mails/empty:
delete:
tags:
- Mails
summary: Empty trash for Mails
operationId: emptyTrashMails
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mails/delete/bulk:
post:
tags:
- Mails
summary: Bulk soft-delete Mails by ids (atomic)
operationId: bulkDeleteMails
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mails/restore/bulk:
post:
tags:
- Mails
summary: Bulk restore Mails by ids (atomic)
operationId: bulkRestoreMails
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mails/restore/all:
post:
tags:
- Mails
summary: Restore all soft-deleted Mails
operationId: restoreAllMails
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mails/trash/bulk:
delete:
tags:
- Mails
summary: Bulk permanently-delete Mails from trash by ids (atomic)
operationId: bulkPermanentDeleteMails
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_notifications:
get:
tags:
- MailNotifications
summary: List MailNotifications
description: Get a paginated list of MailNotifications with optional filtering and sorting
operationId: listMailNotifications
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotificationList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailNotifications
summary: Create MailNotification
description: Create a new MailNotification
operationId: createMailNotification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailNotificationRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_notifications/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailNotifications
summary: Get MailNotification by ID
operationId: getMailNotification
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailNotifications
summary: Update MailNotification (full)
operationId: updateMailNotification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailNotificationRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailNotifications
summary: Update MailNotification (partial)
operationId: patchMailNotification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailNotificationRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailNotifications
summary: Delete MailNotification (soft)
operationId: deleteMailNotification
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_notifications/bulk:
post:
tags:
- MailNotifications
summary: Bulk create MailNotifications
operationId: bulkCreateMailNotifications
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailNotificationRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailNotification'
put:
tags:
- MailNotifications
summary: Bulk update MailNotifications (full, atomic)
operationId: bulkUpdateMailNotifications
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailNotificationRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotificationBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailNotifications
summary: Bulk partial-update MailNotifications (atomic)
operationId: bulkPatchMailNotifications
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotificationBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_notifications/upsert:
post:
tags:
- MailNotifications
summary: Upsert MailNotification
operationId: upsertMailNotification
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailNotificationRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
/api/v1/messaging/mail_notifications/trash:
get:
tags:
- MailNotifications
summary: List deleted MailNotifications
operationId: listDeletedMailNotifications
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotificationList'
/api/v1/messaging/mail_notifications/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailNotifications
summary: Restore deleted MailNotification
operationId: restoreMailNotification
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotification'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_notifications/empty:
delete:
tags:
- MailNotifications
summary: Empty trash for MailNotifications
operationId: emptyTrashMailNotifications
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_notifications/delete/bulk:
post:
tags:
- MailNotifications
summary: Bulk soft-delete MailNotifications by ids (atomic)
operationId: bulkDeleteMailNotifications
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_notifications/restore/bulk:
post:
tags:
- MailNotifications
summary: Bulk restore MailNotifications by ids (atomic)
operationId: bulkRestoreMailNotifications
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailNotificationBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_notifications/restore/all:
post:
tags:
- MailNotifications
summary: Restore all soft-deleted MailNotifications
operationId: restoreAllMailNotifications
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_notifications/trash/bulk:
delete:
tags:
- MailNotifications
summary: Bulk permanently-delete MailNotifications from trash by ids (atomic)
operationId: bulkPermanentDeleteMailNotifications
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_subtypes:
get:
tags:
- MailMessageSubtypes
summary: List MailMessageSubtypes
description: Get a paginated list of MailMessageSubtypes with optional filtering and sorting
operationId: listMailMessageSubtypes
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtypeList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessageSubtypes
summary: Create MailMessageSubtype
description: Create a new MailMessageSubtype
operationId: createMailMessageSubtype
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageSubtypeRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_message_subtypes/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessageSubtypes
summary: Get MailMessageSubtype by ID
operationId: getMailMessageSubtype
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessageSubtypes
summary: Update MailMessageSubtype (full)
operationId: updateMailMessageSubtype
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageSubtypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessageSubtypes
summary: Update MailMessageSubtype (partial)
operationId: patchMailMessageSubtype
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageSubtypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessageSubtypes
summary: Delete MailMessageSubtype (soft)
operationId: deleteMailMessageSubtype
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_subtypes/bulk:
post:
tags:
- MailMessageSubtypes
summary: Bulk create MailMessageSubtypes
operationId: bulkCreateMailMessageSubtypes
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageSubtypeRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessageSubtype'
put:
tags:
- MailMessageSubtypes
summary: Bulk update MailMessageSubtypes (full, atomic)
operationId: bulkUpdateMailMessageSubtypes
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageSubtypeRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessageSubtypes
summary: Bulk partial-update MailMessageSubtypes (atomic)
operationId: bulkPatchMailMessageSubtypes
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_subtypes/upsert:
post:
tags:
- MailMessageSubtypes
summary: Upsert MailMessageSubtype
operationId: upsertMailMessageSubtype
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageSubtypeRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
/api/v1/messaging/mail_message_subtypes/trash:
get:
tags:
- MailMessageSubtypes
summary: List deleted MailMessageSubtypes
operationId: listDeletedMailMessageSubtypes
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtypeList'
/api/v1/messaging/mail_message_subtypes/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessageSubtypes
summary: Restore deleted MailMessageSubtype
operationId: restoreMailMessageSubtype
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtype'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_subtypes/empty:
delete:
tags:
- MailMessageSubtypes
summary: Empty trash for MailMessageSubtypes
operationId: emptyTrashMailMessageSubtypes
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_message_subtypes/delete/bulk:
post:
tags:
- MailMessageSubtypes
summary: Bulk soft-delete MailMessageSubtypes by ids (atomic)
operationId: bulkDeleteMailMessageSubtypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_subtypes/restore/bulk:
post:
tags:
- MailMessageSubtypes
summary: Bulk restore MailMessageSubtypes by ids (atomic)
operationId: bulkRestoreMailMessageSubtypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSubtypeBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_subtypes/restore/all:
post:
tags:
- MailMessageSubtypes
summary: Restore all soft-deleted MailMessageSubtypes
operationId: restoreAllMailMessageSubtypes
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_message_subtypes/trash/bulk:
delete:
tags:
- MailMessageSubtypes
summary: Bulk permanently-delete MailMessageSubtypes from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessageSubtypes
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_reactions:
get:
tags:
- MailMessageReactions
summary: List MailMessageReactions
description: Get a paginated list of MailMessageReactions with optional filtering and sorting
operationId: listMailMessageReactions
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReactionList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessageReactions
summary: Create MailMessageReaction
description: Create a new MailMessageReaction
operationId: createMailMessageReaction
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageReactionRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_message_reactions/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessageReactions
summary: Get MailMessageReaction by ID
operationId: getMailMessageReaction
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessageReactions
summary: Update MailMessageReaction (full)
operationId: updateMailMessageReaction
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageReactionRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessageReactions
summary: Update MailMessageReaction (partial)
operationId: patchMailMessageReaction
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageReactionRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessageReactions
summary: Delete MailMessageReaction (soft)
operationId: deleteMailMessageReaction
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_reactions/bulk:
post:
tags:
- MailMessageReactions
summary: Bulk create MailMessageReactions
operationId: bulkCreateMailMessageReactions
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageReactionRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessageReaction'
put:
tags:
- MailMessageReactions
summary: Bulk update MailMessageReactions (full, atomic)
operationId: bulkUpdateMailMessageReactions
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageReactionRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReactionBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessageReactions
summary: Bulk partial-update MailMessageReactions (atomic)
operationId: bulkPatchMailMessageReactions
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReactionBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_reactions/upsert:
post:
tags:
- MailMessageReactions
summary: Upsert MailMessageReaction
operationId: upsertMailMessageReaction
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageReactionRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
/api/v1/messaging/mail_message_reactions/trash:
get:
tags:
- MailMessageReactions
summary: List deleted MailMessageReactions
operationId: listDeletedMailMessageReactions
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReactionList'
/api/v1/messaging/mail_message_reactions/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessageReactions
summary: Restore deleted MailMessageReaction
operationId: restoreMailMessageReaction
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReaction'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_reactions/empty:
delete:
tags:
- MailMessageReactions
summary: Empty trash for MailMessageReactions
operationId: emptyTrashMailMessageReactions
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_message_reactions/delete/bulk:
post:
tags:
- MailMessageReactions
summary: Bulk soft-delete MailMessageReactions by ids (atomic)
operationId: bulkDeleteMailMessageReactions
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_reactions/restore/bulk:
post:
tags:
- MailMessageReactions
summary: Bulk restore MailMessageReactions by ids (atomic)
operationId: bulkRestoreMailMessageReactions
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageReactionBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_reactions/restore/all:
post:
tags:
- MailMessageReactions
summary: Restore all soft-deleted MailMessageReactions
operationId: restoreAllMailMessageReactions
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_message_reactions/trash/bulk:
delete:
tags:
- MailMessageReactions
summary: Bulk permanently-delete MailMessageReactions from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessageReactions
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_followerses:
get:
tags:
- MailFollowerses
summary: List MailFollowerses
description: Get a paginated list of MailFollowerses with optional filtering and sorting
operationId: listMailFollowerses
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowersList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailFollowerses
summary: Create MailFollowers
description: Create a new MailFollowers
operationId: createMailFollowers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailFollowersRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_followerses/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailFollowerses
summary: Get MailFollowers by ID
operationId: getMailFollowers
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailFollowerses
summary: Update MailFollowers (full)
operationId: updateMailFollowers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailFollowersRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailFollowerses
summary: Update MailFollowers (partial)
operationId: patchMailFollowers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailFollowersRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailFollowerses
summary: Delete MailFollowers (soft)
operationId: deleteMailFollowers
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_followerses/bulk:
post:
tags:
- MailFollowerses
summary: Bulk create MailFollowerses
operationId: bulkCreateMailFollowerses
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailFollowersRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailFollowers'
put:
tags:
- MailFollowerses
summary: Bulk update MailFollowerses (full, atomic)
operationId: bulkUpdateMailFollowerses
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailFollowersRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowersBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailFollowerses
summary: Bulk partial-update MailFollowerses (atomic)
operationId: bulkPatchMailFollowerses
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowersBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_followerses/upsert:
post:
tags:
- MailFollowerses
summary: Upsert MailFollowers
operationId: upsertMailFollowers
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailFollowersRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
/api/v1/messaging/mail_followerses/trash:
get:
tags:
- MailFollowerses
summary: List deleted MailFollowerses
operationId: listDeletedMailFollowerses
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowersList'
/api/v1/messaging/mail_followerses/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailFollowerses
summary: Restore deleted MailFollowers
operationId: restoreMailFollowers
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowers'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_followerses/empty:
delete:
tags:
- MailFollowerses
summary: Empty trash for MailFollowerses
operationId: emptyTrashMailFollowerses
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_followerses/delete/bulk:
post:
tags:
- MailFollowerses
summary: Bulk soft-delete MailFollowerses by ids (atomic)
operationId: bulkDeleteMailFollowerses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_followerses/restore/bulk:
post:
tags:
- MailFollowerses
summary: Bulk restore MailFollowerses by ids (atomic)
operationId: bulkRestoreMailFollowerses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailFollowersBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_followerses/restore/all:
post:
tags:
- MailFollowerses
summary: Restore all soft-deleted MailFollowerses
operationId: restoreAllMailFollowerses
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_followerses/trash/bulk:
delete:
tags:
- MailFollowerses
summary: Bulk permanently-delete MailFollowerses from trash by ids (atomic)
operationId: bulkPermanentDeleteMailFollowerses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_presences:
get:
tags:
- MailPresences
summary: List MailPresences
description: Get a paginated list of MailPresences with optional filtering and sorting
operationId: listMailPresences
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresenceList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailPresences
summary: Create MailPresence
description: Create a new MailPresence
operationId: createMailPresence
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailPresenceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_presences/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailPresences
summary: Get MailPresence by ID
operationId: getMailPresence
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailPresences
summary: Update MailPresence (full)
operationId: updateMailPresence
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailPresenceRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailPresences
summary: Update MailPresence (partial)
operationId: patchMailPresence
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailPresenceRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailPresences
summary: Delete MailPresence (soft)
operationId: deleteMailPresence
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_presences/bulk:
post:
tags:
- MailPresences
summary: Bulk create MailPresences
operationId: bulkCreateMailPresences
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailPresenceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailPresence'
put:
tags:
- MailPresences
summary: Bulk update MailPresences (full, atomic)
operationId: bulkUpdateMailPresences
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailPresenceRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresenceBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailPresences
summary: Bulk partial-update MailPresences (atomic)
operationId: bulkPatchMailPresences
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresenceBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_presences/upsert:
post:
tags:
- MailPresences
summary: Upsert MailPresence
operationId: upsertMailPresence
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailPresenceRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
/api/v1/messaging/mail_presences/trash:
get:
tags:
- MailPresences
summary: List deleted MailPresences
operationId: listDeletedMailPresences
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresenceList'
/api/v1/messaging/mail_presences/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailPresences
summary: Restore deleted MailPresence
operationId: restoreMailPresence
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresence'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_presences/empty:
delete:
tags:
- MailPresences
summary: Empty trash for MailPresences
operationId: emptyTrashMailPresences
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_presences/delete/bulk:
post:
tags:
- MailPresences
summary: Bulk soft-delete MailPresences by ids (atomic)
operationId: bulkDeleteMailPresences
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_presences/restore/bulk:
post:
tags:
- MailPresences
summary: Bulk restore MailPresences by ids (atomic)
operationId: bulkRestoreMailPresences
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailPresenceBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_presences/restore/all:
post:
tags:
- MailPresences
summary: Restore all soft-deleted MailPresences
operationId: restoreAllMailPresences
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_presences/trash/bulk:
delete:
tags:
- MailPresences
summary: Bulk permanently-delete MailPresences from trash by ids (atomic)
operationId: bulkPermanentDeleteMailPresences
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_blacklists:
get:
tags:
- MailBlacklists
summary: List MailBlacklists
description: Get a paginated list of MailBlacklists with optional filtering and sorting
operationId: listMailBlacklists
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklistList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailBlacklists
summary: Create MailBlacklist
description: Create a new MailBlacklist
operationId: createMailBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailBlacklistRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_blacklists/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailBlacklists
summary: Get MailBlacklist by ID
operationId: getMailBlacklist
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailBlacklists
summary: Update MailBlacklist (full)
operationId: updateMailBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailBlacklists
summary: Update MailBlacklist (partial)
operationId: patchMailBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailBlacklists
summary: Delete MailBlacklist (soft)
operationId: deleteMailBlacklist
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_blacklists/bulk:
post:
tags:
- MailBlacklists
summary: Bulk create MailBlacklists
operationId: bulkCreateMailBlacklists
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailBlacklistRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailBlacklist'
put:
tags:
- MailBlacklists
summary: Bulk update MailBlacklists (full, atomic)
operationId: bulkUpdateMailBlacklists
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailBlacklists
summary: Bulk partial-update MailBlacklists (atomic)
operationId: bulkPatchMailBlacklists
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_blacklists/upsert:
post:
tags:
- MailBlacklists
summary: Upsert MailBlacklist
operationId: upsertMailBlacklist
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailBlacklistRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
/api/v1/messaging/mail_blacklists/trash:
get:
tags:
- MailBlacklists
summary: List deleted MailBlacklists
operationId: listDeletedMailBlacklists
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklistList'
/api/v1/messaging/mail_blacklists/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailBlacklists
summary: Restore deleted MailBlacklist
operationId: restoreMailBlacklist
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklist'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_blacklists/empty:
delete:
tags:
- MailBlacklists
summary: Empty trash for MailBlacklists
operationId: emptyTrashMailBlacklists
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_blacklists/delete/bulk:
post:
tags:
- MailBlacklists
summary: Bulk soft-delete MailBlacklists by ids (atomic)
operationId: bulkDeleteMailBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_blacklists/restore/bulk:
post:
tags:
- MailBlacklists
summary: Bulk restore MailBlacklists by ids (atomic)
operationId: bulkRestoreMailBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_blacklists/restore/all:
post:
tags:
- MailBlacklists
summary: Restore all soft-deleted MailBlacklists
operationId: restoreAllMailBlacklists
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_blacklists/trash/bulk:
delete:
tags:
- MailBlacklists
summary: Bulk permanently-delete MailBlacklists from trash by ids (atomic)
operationId: bulkPermanentDeleteMailBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_tracking_values:
get:
tags:
- MailTrackingValues
summary: List MailTrackingValues
description: Get a paginated list of MailTrackingValues with optional filtering and sorting
operationId: listMailTrackingValues
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValueList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailTrackingValues
summary: Create MailTrackingValue
description: Create a new MailTrackingValue
operationId: createMailTrackingValue
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailTrackingValueRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_tracking_values/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailTrackingValues
summary: Get MailTrackingValue by ID
operationId: getMailTrackingValue
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailTrackingValues
summary: Update MailTrackingValue (full)
operationId: updateMailTrackingValue
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailTrackingValueRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailTrackingValues
summary: Update MailTrackingValue (partial)
operationId: patchMailTrackingValue
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailTrackingValueRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailTrackingValues
summary: Delete MailTrackingValue (soft)
operationId: deleteMailTrackingValue
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_tracking_values/bulk:
post:
tags:
- MailTrackingValues
summary: Bulk create MailTrackingValues
operationId: bulkCreateMailTrackingValues
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailTrackingValueRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailTrackingValue'
put:
tags:
- MailTrackingValues
summary: Bulk update MailTrackingValues (full, atomic)
operationId: bulkUpdateMailTrackingValues
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailTrackingValueRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValueBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailTrackingValues
summary: Bulk partial-update MailTrackingValues (atomic)
operationId: bulkPatchMailTrackingValues
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValueBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_tracking_values/upsert:
post:
tags:
- MailTrackingValues
summary: Upsert MailTrackingValue
operationId: upsertMailTrackingValue
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailTrackingValueRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
/api/v1/messaging/mail_tracking_values/trash:
get:
tags:
- MailTrackingValues
summary: List deleted MailTrackingValues
operationId: listDeletedMailTrackingValues
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValueList'
/api/v1/messaging/mail_tracking_values/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailTrackingValues
summary: Restore deleted MailTrackingValue
operationId: restoreMailTrackingValue
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValue'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_tracking_values/empty:
delete:
tags:
- MailTrackingValues
summary: Empty trash for MailTrackingValues
operationId: emptyTrashMailTrackingValues
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_tracking_values/delete/bulk:
post:
tags:
- MailTrackingValues
summary: Bulk soft-delete MailTrackingValues by ids (atomic)
operationId: bulkDeleteMailTrackingValues
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_tracking_values/restore/bulk:
post:
tags:
- MailTrackingValues
summary: Bulk restore MailTrackingValues by ids (atomic)
operationId: bulkRestoreMailTrackingValues
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailTrackingValueBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_tracking_values/restore/all:
post:
tags:
- MailTrackingValues
summary: Restore all soft-deleted MailTrackingValues
operationId: restoreAllMailTrackingValues
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_tracking_values/trash/bulk:
delete:
tags:
- MailTrackingValues
summary: Bulk permanently-delete MailTrackingValues from trash by ids (atomic)
operationId: bulkPermanentDeleteMailTrackingValues
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channels:
get:
tags:
- DiscussChannels
summary: List DiscussChannels
description: Get a paginated list of DiscussChannels with optional filtering and sorting
operationId: listDiscussChannels
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- DiscussChannels
summary: Create DiscussChannel
description: Create a new DiscussChannel
operationId: createDiscussChannel
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDiscussChannelRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/discuss_channels/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- DiscussChannels
summary: Get DiscussChannel by ID
operationId: getDiscussChannel
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- DiscussChannels
summary: Update DiscussChannel (full)
operationId: updateDiscussChannel
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscussChannelRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- DiscussChannels
summary: Update DiscussChannel (partial)
operationId: patchDiscussChannel
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchDiscussChannelRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- DiscussChannels
summary: Delete DiscussChannel (soft)
operationId: deleteDiscussChannel
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/discuss_channels/bulk:
post:
tags:
- DiscussChannels
summary: Bulk create DiscussChannels
operationId: bulkCreateDiscussChannels
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateDiscussChannelRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DiscussChannel'
put:
tags:
- DiscussChannels
summary: Bulk update DiscussChannels (full, atomic)
operationId: bulkUpdateDiscussChannels
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateDiscussChannelRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- DiscussChannels
summary: Bulk partial-update DiscussChannels (atomic)
operationId: bulkPatchDiscussChannels
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channels/upsert:
post:
tags:
- DiscussChannels
summary: Upsert DiscussChannel
operationId: upsertDiscussChannel
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscussChannelRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
/api/v1/messaging/discuss_channels/trash:
get:
tags:
- DiscussChannels
summary: List deleted DiscussChannels
operationId: listDeletedDiscussChannels
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelList'
/api/v1/messaging/discuss_channels/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- DiscussChannels
summary: Restore deleted DiscussChannel
operationId: restoreDiscussChannel
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannel'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/discuss_channels/empty:
delete:
tags:
- DiscussChannels
summary: Empty trash for DiscussChannels
operationId: emptyTrashDiscussChannels
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/discuss_channels/delete/bulk:
post:
tags:
- DiscussChannels
summary: Bulk soft-delete DiscussChannels by ids (atomic)
operationId: bulkDeleteDiscussChannels
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channels/restore/bulk:
post:
tags:
- DiscussChannels
summary: Bulk restore DiscussChannels by ids (atomic)
operationId: bulkRestoreDiscussChannels
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channels/restore/all:
post:
tags:
- DiscussChannels
summary: Restore all soft-deleted DiscussChannels
operationId: restoreAllDiscussChannels
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/discuss_channels/trash/bulk:
delete:
tags:
- DiscussChannels
summary: Bulk permanently-delete DiscussChannels from trash by ids (atomic)
operationId: bulkPermanentDeleteDiscussChannels
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channel_members:
get:
tags:
- DiscussChannelMembers
summary: List DiscussChannelMembers
description: Get a paginated list of DiscussChannelMembers with optional filtering and sorting
operationId: listDiscussChannelMembers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMemberList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- DiscussChannelMembers
summary: Create DiscussChannelMember
description: Create a new DiscussChannelMember
operationId: createDiscussChannelMember
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDiscussChannelMemberRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/discuss_channel_members/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- DiscussChannelMembers
summary: Get DiscussChannelMember by ID
operationId: getDiscussChannelMember
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- DiscussChannelMembers
summary: Update DiscussChannelMember (full)
operationId: updateDiscussChannelMember
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscussChannelMemberRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- DiscussChannelMembers
summary: Update DiscussChannelMember (partial)
operationId: patchDiscussChannelMember
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchDiscussChannelMemberRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- DiscussChannelMembers
summary: Delete DiscussChannelMember (soft)
operationId: deleteDiscussChannelMember
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/discuss_channel_members/bulk:
post:
tags:
- DiscussChannelMembers
summary: Bulk create DiscussChannelMembers
operationId: bulkCreateDiscussChannelMembers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateDiscussChannelMemberRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DiscussChannelMember'
put:
tags:
- DiscussChannelMembers
summary: Bulk update DiscussChannelMembers (full, atomic)
operationId: bulkUpdateDiscussChannelMembers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateDiscussChannelMemberRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMemberBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- DiscussChannelMembers
summary: Bulk partial-update DiscussChannelMembers (atomic)
operationId: bulkPatchDiscussChannelMembers
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMemberBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channel_members/upsert:
post:
tags:
- DiscussChannelMembers
summary: Upsert DiscussChannelMember
operationId: upsertDiscussChannelMember
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscussChannelMemberRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
/api/v1/messaging/discuss_channel_members/trash:
get:
tags:
- DiscussChannelMembers
summary: List deleted DiscussChannelMembers
operationId: listDeletedDiscussChannelMembers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMemberList'
/api/v1/messaging/discuss_channel_members/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- DiscussChannelMembers
summary: Restore deleted DiscussChannelMember
operationId: restoreDiscussChannelMember
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMember'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/discuss_channel_members/empty:
delete:
tags:
- DiscussChannelMembers
summary: Empty trash for DiscussChannelMembers
operationId: emptyTrashDiscussChannelMembers
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/discuss_channel_members/delete/bulk:
post:
tags:
- DiscussChannelMembers
summary: Bulk soft-delete DiscussChannelMembers by ids (atomic)
operationId: bulkDeleteDiscussChannelMembers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channel_members/restore/bulk:
post:
tags:
- DiscussChannelMembers
summary: Bulk restore DiscussChannelMembers by ids (atomic)
operationId: bulkRestoreDiscussChannelMembers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/DiscussChannelMemberBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/discuss_channel_members/restore/all:
post:
tags:
- DiscussChannelMembers
summary: Restore all soft-deleted DiscussChannelMembers
operationId: restoreAllDiscussChannelMembers
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/discuss_channel_members/trash/bulk:
delete:
tags:
- DiscussChannelMembers
summary: Bulk permanently-delete DiscussChannelMembers from trash by ids (atomic)
operationId: bulkPermanentDeleteDiscussChannelMembers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_guests:
get:
tags:
- MailGuests
summary: List MailGuests
description: Get a paginated list of MailGuests with optional filtering and sorting
operationId: listMailGuests
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuestList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailGuests
summary: Create MailGuest
description: Create a new MailGuest
operationId: createMailGuest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailGuestRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_guests/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailGuests
summary: Get MailGuest by ID
operationId: getMailGuest
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailGuests
summary: Update MailGuest (full)
operationId: updateMailGuest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailGuestRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailGuests
summary: Update MailGuest (partial)
operationId: patchMailGuest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailGuestRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailGuests
summary: Delete MailGuest (soft)
operationId: deleteMailGuest
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_guests/bulk:
post:
tags:
- MailGuests
summary: Bulk create MailGuests
operationId: bulkCreateMailGuests
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailGuestRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailGuest'
put:
tags:
- MailGuests
summary: Bulk update MailGuests (full, atomic)
operationId: bulkUpdateMailGuests
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailGuestRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuestBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailGuests
summary: Bulk partial-update MailGuests (atomic)
operationId: bulkPatchMailGuests
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuestBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_guests/upsert:
post:
tags:
- MailGuests
summary: Upsert MailGuest
operationId: upsertMailGuest
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailGuestRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
/api/v1/messaging/mail_guests/trash:
get:
tags:
- MailGuests
summary: List deleted MailGuests
operationId: listDeletedMailGuests
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuestList'
/api/v1/messaging/mail_guests/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailGuests
summary: Restore deleted MailGuest
operationId: restoreMailGuest
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuest'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_guests/empty:
delete:
tags:
- MailGuests
summary: Empty trash for MailGuests
operationId: emptyTrashMailGuests
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_guests/delete/bulk:
post:
tags:
- MailGuests
summary: Bulk soft-delete MailGuests by ids (atomic)
operationId: bulkDeleteMailGuests
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_guests/restore/bulk:
post:
tags:
- MailGuests
summary: Bulk restore MailGuests by ids (atomic)
operationId: bulkRestoreMailGuests
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailGuestBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_guests/restore/all:
post:
tags:
- MailGuests
summary: Restore all soft-deleted MailGuests
operationId: restoreAllMailGuests
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_guests/trash/bulk:
delete:
tags:
- MailGuests
summary: Bulk permanently-delete MailGuests from trash by ids (atomic)
operationId: bulkPermanentDeleteMailGuests
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_servers:
get:
tags:
- MailServers
summary: List MailServers
description: Get a paginated list of MailServers with optional filtering and sorting
operationId: listMailServers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailServerList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailServers
summary: Create MailServer
description: Create a new MailServer
operationId: createMailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailServerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_servers/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailServers
summary: Get MailServer by ID
operationId: getMailServer
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailServers
summary: Update MailServer (full)
operationId: updateMailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailServers
summary: Update MailServer (partial)
operationId: patchMailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailServers
summary: Delete MailServer (soft)
operationId: deleteMailServer
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_servers/bulk:
post:
tags:
- MailServers
summary: Bulk create MailServers
operationId: bulkCreateMailServers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailServerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailServer'
put:
tags:
- MailServers
summary: Bulk update MailServers (full, atomic)
operationId: bulkUpdateMailServers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailServers
summary: Bulk partial-update MailServers (atomic)
operationId: bulkPatchMailServers
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_servers/upsert:
post:
tags:
- MailServers
summary: Upsert MailServer
operationId: upsertMailServer
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailServerRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
/api/v1/messaging/mail_servers/trash:
get:
tags:
- MailServers
summary: List deleted MailServers
operationId: listDeletedMailServers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailServerList'
/api/v1/messaging/mail_servers/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailServers
summary: Restore deleted MailServer
operationId: restoreMailServer
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_servers/empty:
delete:
tags:
- MailServers
summary: Empty trash for MailServers
operationId: emptyTrashMailServers
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_servers/delete/bulk:
post:
tags:
- MailServers
summary: Bulk soft-delete MailServers by ids (atomic)
operationId: bulkDeleteMailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_servers/restore/bulk:
post:
tags:
- MailServers
summary: Bulk restore MailServers by ids (atomic)
operationId: bulkRestoreMailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_servers/restore/all:
post:
tags:
- MailServers
summary: Restore all soft-deleted MailServers
operationId: restoreAllMailServers
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_servers/trash/bulk:
delete:
tags:
- MailServers
summary: Bulk permanently-delete MailServers from trash by ids (atomic)
operationId: bulkPermanentDeleteMailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/fetchmail_servers:
get:
tags:
- FetchmailServers
summary: List FetchmailServers
description: Get a paginated list of FetchmailServers with optional filtering and sorting
operationId: listFetchmailServers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServerList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- FetchmailServers
summary: Create FetchmailServer
description: Create a new FetchmailServer
operationId: createFetchmailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFetchmailServerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/fetchmail_servers/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- FetchmailServers
summary: Get FetchmailServer by ID
operationId: getFetchmailServer
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- FetchmailServers
summary: Update FetchmailServer (full)
operationId: updateFetchmailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFetchmailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- FetchmailServers
summary: Update FetchmailServer (partial)
operationId: patchFetchmailServer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchFetchmailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- FetchmailServers
summary: Delete FetchmailServer (soft)
operationId: deleteFetchmailServer
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/fetchmail_servers/bulk:
post:
tags:
- FetchmailServers
summary: Bulk create FetchmailServers
operationId: bulkCreateFetchmailServers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateFetchmailServerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FetchmailServer'
put:
tags:
- FetchmailServers
summary: Bulk update FetchmailServers (full, atomic)
operationId: bulkUpdateFetchmailServers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateFetchmailServerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- FetchmailServers
summary: Bulk partial-update FetchmailServers (atomic)
operationId: bulkPatchFetchmailServers
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/fetchmail_servers/upsert:
post:
tags:
- FetchmailServers
summary: Upsert FetchmailServer
operationId: upsertFetchmailServer
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFetchmailServerRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
/api/v1/messaging/fetchmail_servers/trash:
get:
tags:
- FetchmailServers
summary: List deleted FetchmailServers
operationId: listDeletedFetchmailServers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServerList'
/api/v1/messaging/fetchmail_servers/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- FetchmailServers
summary: Restore deleted FetchmailServer
operationId: restoreFetchmailServer
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServer'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/fetchmail_servers/empty:
delete:
tags:
- FetchmailServers
summary: Empty trash for FetchmailServers
operationId: emptyTrashFetchmailServers
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/fetchmail_servers/delete/bulk:
post:
tags:
- FetchmailServers
summary: Bulk soft-delete FetchmailServers by ids (atomic)
operationId: bulkDeleteFetchmailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/fetchmail_servers/restore/bulk:
post:
tags:
- FetchmailServers
summary: Bulk restore FetchmailServers by ids (atomic)
operationId: bulkRestoreFetchmailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/FetchmailServerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/fetchmail_servers/restore/all:
post:
tags:
- FetchmailServers
summary: Restore all soft-deleted FetchmailServers
operationId: restoreAllFetchmailServers
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/fetchmail_servers/trash/bulk:
delete:
tags:
- FetchmailServers
summary: Bulk permanently-delete FetchmailServers from trash by ids (atomic)
operationId: bulkPermanentDeleteFetchmailServers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_gateway_alloweds:
get:
tags:
- MailGatewayAlloweds
summary: List MailGatewayAlloweds
description: Get a paginated list of MailGatewayAlloweds with optional filtering and sorting
operationId: listMailGatewayAlloweds
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowedList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailGatewayAlloweds
summary: Create MailGatewayAllowed
description: Create a new MailGatewayAllowed
operationId: createMailGatewayAllowed
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailGatewayAllowedRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_gateway_alloweds/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailGatewayAlloweds
summary: Get MailGatewayAllowed by ID
operationId: getMailGatewayAllowed
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailGatewayAlloweds
summary: Update MailGatewayAllowed (full)
operationId: updateMailGatewayAllowed
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailGatewayAllowedRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailGatewayAlloweds
summary: Update MailGatewayAllowed (partial)
operationId: patchMailGatewayAllowed
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailGatewayAllowedRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailGatewayAlloweds
summary: Delete MailGatewayAllowed (soft)
operationId: deleteMailGatewayAllowed
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_gateway_alloweds/bulk:
post:
tags:
- MailGatewayAlloweds
summary: Bulk create MailGatewayAlloweds
operationId: bulkCreateMailGatewayAlloweds
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailGatewayAllowedRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailGatewayAllowed'
put:
tags:
- MailGatewayAlloweds
summary: Bulk update MailGatewayAlloweds (full, atomic)
operationId: bulkUpdateMailGatewayAlloweds
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailGatewayAllowedRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowedBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailGatewayAlloweds
summary: Bulk partial-update MailGatewayAlloweds (atomic)
operationId: bulkPatchMailGatewayAlloweds
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowedBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_gateway_alloweds/upsert:
post:
tags:
- MailGatewayAlloweds
summary: Upsert MailGatewayAllowed
operationId: upsertMailGatewayAllowed
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailGatewayAllowedRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
/api/v1/messaging/mail_gateway_alloweds/trash:
get:
tags:
- MailGatewayAlloweds
summary: List deleted MailGatewayAlloweds
operationId: listDeletedMailGatewayAlloweds
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowedList'
/api/v1/messaging/mail_gateway_alloweds/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailGatewayAlloweds
summary: Restore deleted MailGatewayAllowed
operationId: restoreMailGatewayAllowed
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowed'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_gateway_alloweds/empty:
delete:
tags:
- MailGatewayAlloweds
summary: Empty trash for MailGatewayAlloweds
operationId: emptyTrashMailGatewayAlloweds
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_gateway_alloweds/delete/bulk:
post:
tags:
- MailGatewayAlloweds
summary: Bulk soft-delete MailGatewayAlloweds by ids (atomic)
operationId: bulkDeleteMailGatewayAlloweds
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_gateway_alloweds/restore/bulk:
post:
tags:
- MailGatewayAlloweds
summary: Bulk restore MailGatewayAlloweds by ids (atomic)
operationId: bulkRestoreMailGatewayAlloweds
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailGatewayAllowedBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_gateway_alloweds/restore/all:
post:
tags:
- MailGatewayAlloweds
summary: Restore all soft-deleted MailGatewayAlloweds
operationId: restoreAllMailGatewayAlloweds
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_gateway_alloweds/trash/bulk:
delete:
tags:
- MailGatewayAlloweds
summary: Bulk permanently-delete MailGatewayAlloweds from trash by ids (atomic)
operationId: bulkPermanentDeleteMailGatewayAlloweds
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/phone_blacklists:
get:
tags:
- PhoneBlacklists
summary: List PhoneBlacklists
description: Get a paginated list of PhoneBlacklists with optional filtering and sorting
operationId: listPhoneBlacklists
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklistList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- PhoneBlacklists
summary: Create PhoneBlacklist
description: Create a new PhoneBlacklist
operationId: createPhoneBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePhoneBlacklistRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/phone_blacklists/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- PhoneBlacklists
summary: Get PhoneBlacklist by ID
operationId: getPhoneBlacklist
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- PhoneBlacklists
summary: Update PhoneBlacklist (full)
operationId: updatePhoneBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePhoneBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- PhoneBlacklists
summary: Update PhoneBlacklist (partial)
operationId: patchPhoneBlacklist
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchPhoneBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- PhoneBlacklists
summary: Delete PhoneBlacklist (soft)
operationId: deletePhoneBlacklist
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/phone_blacklists/bulk:
post:
tags:
- PhoneBlacklists
summary: Bulk create PhoneBlacklists
operationId: bulkCreatePhoneBlacklists
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreatePhoneBlacklistRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PhoneBlacklist'
put:
tags:
- PhoneBlacklists
summary: Bulk update PhoneBlacklists (full, atomic)
operationId: bulkUpdatePhoneBlacklists
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdatePhoneBlacklistRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- PhoneBlacklists
summary: Bulk partial-update PhoneBlacklists (atomic)
operationId: bulkPatchPhoneBlacklists
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/phone_blacklists/upsert:
post:
tags:
- PhoneBlacklists
summary: Upsert PhoneBlacklist
operationId: upsertPhoneBlacklist
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePhoneBlacklistRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
/api/v1/messaging/phone_blacklists/trash:
get:
tags:
- PhoneBlacklists
summary: List deleted PhoneBlacklists
operationId: listDeletedPhoneBlacklists
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklistList'
/api/v1/messaging/phone_blacklists/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- PhoneBlacklists
summary: Restore deleted PhoneBlacklist
operationId: restorePhoneBlacklist
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklist'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/phone_blacklists/empty:
delete:
tags:
- PhoneBlacklists
summary: Empty trash for PhoneBlacklists
operationId: emptyTrashPhoneBlacklists
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/phone_blacklists/delete/bulk:
post:
tags:
- PhoneBlacklists
summary: Bulk soft-delete PhoneBlacklists by ids (atomic)
operationId: bulkDeletePhoneBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/phone_blacklists/restore/bulk:
post:
tags:
- PhoneBlacklists
summary: Bulk restore PhoneBlacklists by ids (atomic)
operationId: bulkRestorePhoneBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneBlacklistBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/phone_blacklists/restore/all:
post:
tags:
- PhoneBlacklists
summary: Restore all soft-deleted PhoneBlacklists
operationId: restoreAllPhoneBlacklists
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/phone_blacklists/trash/bulk:
delete:
tags:
- PhoneBlacklists
summary: Bulk permanently-delete PhoneBlacklists from trash by ids (atomic)
operationId: bulkPermanentDeletePhoneBlacklists
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_schedules:
get:
tags:
- MailMessageSchedules
summary: List MailMessageSchedules
description: Get a paginated list of MailMessageSchedules with optional filtering and sorting
operationId: listMailMessageSchedules
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageScheduleList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailMessageSchedules
summary: Create MailMessageSchedule
description: Create a new MailMessageSchedule
operationId: createMailMessageSchedule
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailMessageScheduleRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_message_schedules/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailMessageSchedules
summary: Get MailMessageSchedule by ID
operationId: getMailMessageSchedule
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailMessageSchedules
summary: Update MailMessageSchedule (full)
operationId: updateMailMessageSchedule
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageScheduleRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailMessageSchedules
summary: Update MailMessageSchedule (partial)
operationId: patchMailMessageSchedule
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailMessageScheduleRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailMessageSchedules
summary: Delete MailMessageSchedule (soft)
operationId: deleteMailMessageSchedule
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_schedules/bulk:
post:
tags:
- MailMessageSchedules
summary: Bulk create MailMessageSchedules
operationId: bulkCreateMailMessageSchedules
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailMessageScheduleRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailMessageSchedule'
put:
tags:
- MailMessageSchedules
summary: Bulk update MailMessageSchedules (full, atomic)
operationId: bulkUpdateMailMessageSchedules
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailMessageScheduleRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageScheduleBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailMessageSchedules
summary: Bulk partial-update MailMessageSchedules (atomic)
operationId: bulkPatchMailMessageSchedules
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageScheduleBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_schedules/upsert:
post:
tags:
- MailMessageSchedules
summary: Upsert MailMessageSchedule
operationId: upsertMailMessageSchedule
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailMessageScheduleRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
/api/v1/messaging/mail_message_schedules/trash:
get:
tags:
- MailMessageSchedules
summary: List deleted MailMessageSchedules
operationId: listDeletedMailMessageSchedules
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageScheduleList'
/api/v1/messaging/mail_message_schedules/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailMessageSchedules
summary: Restore deleted MailMessageSchedule
operationId: restoreMailMessageSchedule
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageSchedule'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_message_schedules/empty:
delete:
tags:
- MailMessageSchedules
summary: Empty trash for MailMessageSchedules
operationId: emptyTrashMailMessageSchedules
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_message_schedules/delete/bulk:
post:
tags:
- MailMessageSchedules
summary: Bulk soft-delete MailMessageSchedules by ids (atomic)
operationId: bulkDeleteMailMessageSchedules
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_schedules/restore/bulk:
post:
tags:
- MailMessageSchedules
summary: Bulk restore MailMessageSchedules by ids (atomic)
operationId: bulkRestoreMailMessageSchedules
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailMessageScheduleBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_message_schedules/restore/all:
post:
tags:
- MailMessageSchedules
summary: Restore all soft-deleted MailMessageSchedules
operationId: restoreAllMailMessageSchedules
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_message_schedules/trash/bulk:
delete:
tags:
- MailMessageSchedules
summary: Bulk permanently-delete MailMessageSchedules from trash by ids (atomic)
operationId: bulkPermanentDeleteMailMessageSchedules
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_scheduled_messages:
get:
tags:
- MailScheduledMessages
summary: List MailScheduledMessages
description: Get a paginated list of MailScheduledMessages with optional filtering and sorting
operationId: listMailScheduledMessages
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessageList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- MailScheduledMessages
summary: Create MailScheduledMessage
description: Create a new MailScheduledMessage
operationId: createMailScheduledMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMailScheduledMessageRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/mail_scheduled_messages/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- MailScheduledMessages
summary: Get MailScheduledMessage by ID
operationId: getMailScheduledMessage
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- MailScheduledMessages
summary: Update MailScheduledMessage (full)
operationId: updateMailScheduledMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailScheduledMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- MailScheduledMessages
summary: Update MailScheduledMessage (partial)
operationId: patchMailScheduledMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchMailScheduledMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- MailScheduledMessages
summary: Delete MailScheduledMessage (soft)
operationId: deleteMailScheduledMessage
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_scheduled_messages/bulk:
post:
tags:
- MailScheduledMessages
summary: Bulk create MailScheduledMessages
operationId: bulkCreateMailScheduledMessages
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailScheduledMessageRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailScheduledMessage'
put:
tags:
- MailScheduledMessages
summary: Bulk update MailScheduledMessages (full, atomic)
operationId: bulkUpdateMailScheduledMessages
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateMailScheduledMessageRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- MailScheduledMessages
summary: Bulk partial-update MailScheduledMessages (atomic)
operationId: bulkPatchMailScheduledMessages
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_scheduled_messages/upsert:
post:
tags:
- MailScheduledMessages
summary: Upsert MailScheduledMessage
operationId: upsertMailScheduledMessage
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailScheduledMessageRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
/api/v1/messaging/mail_scheduled_messages/trash:
get:
tags:
- MailScheduledMessages
summary: List deleted MailScheduledMessages
operationId: listDeletedMailScheduledMessages
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessageList'
/api/v1/messaging/mail_scheduled_messages/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- MailScheduledMessages
summary: Restore deleted MailScheduledMessage
operationId: restoreMailScheduledMessage
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessage'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/mail_scheduled_messages/empty:
delete:
tags:
- MailScheduledMessages
summary: Empty trash for MailScheduledMessages
operationId: emptyTrashMailScheduledMessages
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/mail_scheduled_messages/delete/bulk:
post:
tags:
- MailScheduledMessages
summary: Bulk soft-delete MailScheduledMessages by ids (atomic)
operationId: bulkDeleteMailScheduledMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_scheduled_messages/restore/bulk:
post:
tags:
- MailScheduledMessages
summary: Bulk restore MailScheduledMessages by ids (atomic)
operationId: bulkRestoreMailScheduledMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/MailScheduledMessageBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/mail_scheduled_messages/restore/all:
post:
tags:
- MailScheduledMessages
summary: Restore all soft-deleted MailScheduledMessages
operationId: restoreAllMailScheduledMessages
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/mail_scheduled_messages/trash/bulk:
delete:
tags:
- MailScheduledMessages
summary: Bulk permanently-delete MailScheduledMessages from trash by ids (atomic)
operationId: bulkPermanentDeleteMailScheduledMessages
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/smses:
get:
tags:
- Smses
summary: List Smses
description: Get a paginated list of Smses with optional filtering and sorting
operationId: listSmses
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- Smses
summary: Create Sms
description: Create a new Sms
operationId: createSms
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSmsRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/smses/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- Smses
summary: Get Sms by ID
operationId: getSms
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- Smses
summary: Update Sms (full)
operationId: updateSms
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Smses
summary: Update Sms (partial)
operationId: patchSms
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchSmsRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Smses
summary: Delete Sms (soft)
operationId: deleteSms
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/smses/bulk:
post:
tags:
- Smses
summary: Bulk create Smses
operationId: bulkCreateSmses
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateSmsRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Sms'
put:
tags:
- Smses
summary: Bulk update Smses (full, atomic)
operationId: bulkUpdateSmses
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateSmsRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- Smses
summary: Bulk partial-update Smses (atomic)
operationId: bulkPatchSmses
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/smses/upsert:
post:
tags:
- Smses
summary: Upsert Sms
operationId: upsertSms
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
/api/v1/messaging/smses/trash:
get:
tags:
- Smses
summary: List deleted Smses
operationId: listDeletedSmses
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsList'
/api/v1/messaging/smses/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- Smses
summary: Restore deleted Sms
operationId: restoreSms
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/Sms'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/smses/empty:
delete:
tags:
- Smses
summary: Empty trash for Smses
operationId: emptyTrashSmses
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/smses/delete/bulk:
post:
tags:
- Smses
summary: Bulk soft-delete Smses by ids (atomic)
operationId: bulkDeleteSmses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/smses/restore/bulk:
post:
tags:
- Smses
summary: Bulk restore Smses by ids (atomic)
operationId: bulkRestoreSmses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/SmsBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/smses/restore/all:
post:
tags:
- Smses
summary: Restore all soft-deleted Smses
operationId: restoreAllSmses
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/smses/trash/bulk:
delete:
tags:
- Smses
summary: Bulk permanently-delete Smses from trash by ids (atomic)
operationId: bulkPermanentDeleteSmses
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_templates:
get:
tags:
- SmsTemplates
summary: List SmsTemplates
description: Get a paginated list of SmsTemplates with optional filtering and sorting
operationId: listSmsTemplates
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplateList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- SmsTemplates
summary: Create SmsTemplate
description: Create a new SmsTemplate
operationId: createSmsTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSmsTemplateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/sms_templates/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- SmsTemplates
summary: Get SmsTemplate by ID
operationId: getSmsTemplate
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- SmsTemplates
summary: Update SmsTemplate (full)
operationId: updateSmsTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- SmsTemplates
summary: Update SmsTemplate (partial)
operationId: patchSmsTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchSmsTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- SmsTemplates
summary: Delete SmsTemplate (soft)
operationId: deleteSmsTemplate
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/sms_templates/bulk:
post:
tags:
- SmsTemplates
summary: Bulk create SmsTemplates
operationId: bulkCreateSmsTemplates
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateSmsTemplateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SmsTemplate'
put:
tags:
- SmsTemplates
summary: Bulk update SmsTemplates (full, atomic)
operationId: bulkUpdateSmsTemplates
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateSmsTemplateRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- SmsTemplates
summary: Bulk partial-update SmsTemplates (atomic)
operationId: bulkPatchSmsTemplates
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_templates/upsert:
post:
tags:
- SmsTemplates
summary: Upsert SmsTemplate
operationId: upsertSmsTemplate
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsTemplateRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
/api/v1/messaging/sms_templates/trash:
get:
tags:
- SmsTemplates
summary: List deleted SmsTemplates
operationId: listDeletedSmsTemplates
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplateList'
/api/v1/messaging/sms_templates/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- SmsTemplates
summary: Restore deleted SmsTemplate
operationId: restoreSmsTemplate
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplate'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/sms_templates/empty:
delete:
tags:
- SmsTemplates
summary: Empty trash for SmsTemplates
operationId: emptyTrashSmsTemplates
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/sms_templates/delete/bulk:
post:
tags:
- SmsTemplates
summary: Bulk soft-delete SmsTemplates by ids (atomic)
operationId: bulkDeleteSmsTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_templates/restore/bulk:
post:
tags:
- SmsTemplates
summary: Bulk restore SmsTemplates by ids (atomic)
operationId: bulkRestoreSmsTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTemplateBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_templates/restore/all:
post:
tags:
- SmsTemplates
summary: Restore all soft-deleted SmsTemplates
operationId: restoreAllSmsTemplates
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/sms_templates/trash/bulk:
delete:
tags:
- SmsTemplates
summary: Bulk permanently-delete SmsTemplates from trash by ids (atomic)
operationId: bulkPermanentDeleteSmsTemplates
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_trackers:
get:
tags:
- SmsTrackers
summary: List SmsTrackers
description: Get a paginated list of SmsTrackers with optional filtering and sorting
operationId: listSmsTrackers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/SortByParam'
- $ref: '#/components/parameters/SortOrderParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTrackerList'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- SmsTrackers
summary: Create SmsTracker
description: Create a new SmsTracker
operationId: createSmsTracker
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSmsTrackerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/messaging/sms_trackers/{id}:
parameters:
- $ref: '#/components/parameters/IdParam'
get:
tags:
- SmsTrackers
summary: Get SmsTracker by ID
operationId: getSmsTracker
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- SmsTrackers
summary: Update SmsTracker (full)
operationId: updateSmsTracker
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsTrackerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- SmsTrackers
summary: Update SmsTracker (partial)
operationId: patchSmsTracker
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchSmsTrackerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- SmsTrackers
summary: Delete SmsTracker (soft)
operationId: deleteSmsTracker
responses:
'204':
description: Deleted
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/sms_trackers/bulk:
post:
tags:
- SmsTrackers
summary: Bulk create SmsTrackers
operationId: bulkCreateSmsTrackers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateSmsTrackerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SmsTracker'
put:
tags:
- SmsTrackers
summary: Bulk update SmsTrackers (full, atomic)
operationId: bulkUpdateSmsTrackers
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
required: [id]
properties:
id:
type: string
- $ref: '#/components/schemas/UpdateSmsTrackerRequest'
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTrackerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
patch:
tags:
- SmsTrackers
summary: Bulk partial-update SmsTrackers (atomic)
operationId: bulkPatchSmsTrackers
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
required: [ids, patch]
properties:
ids:
type: array
items: { type: string }
patch:
type: object
additionalProperties: true
- type: object
required: [items]
properties:
items:
type: array
items:
type: object
required: [id, patch]
properties:
id: { type: string }
patch: { type: object, additionalProperties: true }
responses:
'200':
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTrackerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_trackers/upsert:
post:
tags:
- SmsTrackers
summary: Upsert SmsTracker
operationId: upsertSmsTracker
parameters:
- name: key_field
in: query
schema:
type: string
- name: key_value
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmsTrackerRequest'
responses:
'200':
description: Upserted
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
/api/v1/messaging/sms_trackers/trash:
get:
tags:
- SmsTrackers
summary: List deleted SmsTrackers
operationId: listDeletedSmsTrackers
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTrackerList'
/api/v1/messaging/sms_trackers/{id}/restore:
parameters:
- $ref: '#/components/parameters/IdParam'
post:
tags:
- SmsTrackers
summary: Restore deleted SmsTracker
operationId: restoreSmsTracker
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTracker'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/messaging/sms_trackers/empty:
delete:
tags:
- SmsTrackers
summary: Empty trash for SmsTrackers
operationId: emptyTrashSmsTrackers
responses:
'200':
description: Trash emptied
content:
application/json:
schema:
type: object
properties:
deleted_count:
type: integer
/api/v1/messaging/sms_trackers/delete/bulk:
post:
tags:
- SmsTrackers
summary: Bulk soft-delete SmsTrackers by ids (atomic)
operationId: bulkDeleteSmsTrackers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Soft-deleted
content:
application/json:
schema:
type: object
properties:
soft_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_trackers/restore/bulk:
post:
tags:
- SmsTrackers
summary: Bulk restore SmsTrackers by ids (atomic)
operationId: bulkRestoreSmsTrackers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Restored
content:
application/json:
schema:
$ref: '#/components/schemas/SmsTrackerBulkResult'
'400':
$ref: '#/components/responses/BadRequest'
/api/v1/messaging/sms_trackers/restore/all:
post:
tags:
- SmsTrackers
summary: Restore all soft-deleted SmsTrackers
operationId: restoreAllSmsTrackers
responses:
'200':
description: Restored
content:
application/json:
schema:
type: object
properties:
restored: { type: integer }
/api/v1/messaging/sms_trackers/trash/bulk:
delete:
tags:
- SmsTrackers
summary: Bulk permanently-delete SmsTrackers from trash by ids (atomic)
operationId: bulkPermanentDeleteSmsTrackers
requestBody:
$ref: '#/components/requestBodies/BatchIds'
responses:
'200':
description: Permanently deleted
content:
application/json:
schema:
type: object
properties:
permanently_deleted: { type: integer }
'400':
$ref: '#/components/responses/BadRequest'
components:
schemas:
MailActivity:
type: object
required:
- id
- res_model
- res_id
- date_deadline
- user_id
- state
- active
- has_recommended_activities
- metadata
properties:
id:
type: string
format: uuid
res_model:
type: string
res_id:
type: string
format: uuid
res_model_id:
nullable: true
type: string
format: uuid
activity_type_id:
nullable: true
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
date_deadline:
type: string
format: date
user_id:
type: string
format: uuid
requested_user_id:
nullable: true
type: string
format: uuid
state:
type: string
active:
type: boolean
has_recommended_activities:
type: boolean
chained_next_activity:
nullable: true
type: object
calendar_event_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailActivityBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivity'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailActivityRequest:
type: object
required:
- res_model
- res_id
- date_deadline
- user_id
- state
- active
- has_recommended_activities
- metadata
properties:
res_model:
type: string
res_id:
type: string
format: uuid
res_model_id:
nullable: true
type: string
format: uuid
activity_type_id:
nullable: true
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
date_deadline:
type: string
format: date
user_id:
type: string
format: uuid
requested_user_id:
nullable: true
type: string
format: uuid
state:
type: string
active:
type: boolean
has_recommended_activities:
type: boolean
chained_next_activity:
nullable: true
type: object
calendar_event_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateMailActivityRequest:
type: object
required:
- res_model
- res_id
- date_deadline
- user_id
- state
- active
- has_recommended_activities
- metadata
properties:
res_model:
type: string
res_id:
type: string
format: uuid
res_model_id:
nullable: true
type: string
format: uuid
activity_type_id:
nullable: true
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
date_deadline:
type: string
format: date
user_id:
type: string
format: uuid
requested_user_id:
nullable: true
type: string
format: uuid
state:
type: string
active:
type: boolean
has_recommended_activities:
type: boolean
chained_next_activity:
nullable: true
type: object
calendar_event_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchMailActivityRequest:
type: object
properties:
res_model:
type: string
res_id:
type: string
format: uuid
res_model_id:
nullable: true
type: string
format: uuid
activity_type_id:
nullable: true
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
date_deadline:
type: string
format: date
user_id:
type: string
format: uuid
requested_user_id:
nullable: true
type: string
format: uuid
state:
type: string
active:
type: boolean
has_recommended_activities:
type: boolean
chained_next_activity:
nullable: true
type: object
calendar_event_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailActivityList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivity'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailActivityType:
type: object
required:
- id
- name
- chaining_type
- delay_count
- delay_unit
- delay_from
- active
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
summary:
nullable: true
type: string
note:
nullable: true
type: string
category:
nullable: true
type: string
chaining_type:
type: string
delay_count:
type: integer
format: int32
delay_unit:
type: string
delay_from:
type: string
default_user_id:
nullable: true
type: string
format: uuid
default_note:
nullable: true
type: string
icon:
nullable: true
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailActivityTypeBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityType'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailActivityTypeRequest:
type: object
required:
- name
- chaining_type
- delay_count
- delay_unit
- delay_from
- active
- metadata
properties:
name:
type: string
summary:
nullable: true
type: string
note:
nullable: true
type: string
category:
nullable: true
type: string
chaining_type:
type: string
delay_count:
type: integer
format: int32
delay_unit:
type: string
delay_from:
type: string
default_user_id:
nullable: true
type: string
format: uuid
default_note:
nullable: true
type: string
icon:
nullable: true
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
UpdateMailActivityTypeRequest:
type: object
required:
- name
- chaining_type
- delay_count
- delay_unit
- delay_from
- active
- metadata
properties:
name:
type: string
summary:
nullable: true
type: string
note:
nullable: true
type: string
category:
nullable: true
type: string
chaining_type:
type: string
delay_count:
type: integer
format: int32
delay_unit:
type: string
delay_from:
type: string
default_user_id:
nullable: true
type: string
format: uuid
default_note:
nullable: true
type: string
icon:
nullable: true
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
PatchMailActivityTypeRequest:
type: object
properties:
name:
type: string
summary:
nullable: true
type: string
note:
nullable: true
type: string
category:
nullable: true
type: string
chaining_type:
type: string
delay_count:
type: integer
format: int32
delay_unit:
type: string
delay_from:
type: string
default_user_id:
nullable: true
type: string
format: uuid
default_note:
nullable: true
type: string
icon:
nullable: true
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailActivityTypeList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityType'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailActivityPlan:
type: object
required:
- id
- name
- active
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailActivityPlanBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityPlan'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailActivityPlanRequest:
type: object
required:
- name
- active
- metadata
properties:
name:
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
UpdateMailActivityPlanRequest:
type: object
required:
- name
- active
- metadata
properties:
name:
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
PatchMailActivityPlanRequest:
type: object
properties:
name:
type: string
res_model:
nullable: true
type: string
res_model_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailActivityPlanList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityPlan'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailActivityPlanTemplate:
type: object
required:
- id
- plan_id
- activity_type_id
- metadata
properties:
id:
type: string
format: uuid
plan_id:
type: string
format: uuid
activity_type_id:
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
delay_count:
nullable: true
type: integer
format: int32
delay_unit:
nullable: true
type: string
user_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailActivityPlanTemplateBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityPlanTemplate'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailActivityPlanTemplateRequest:
type: object
required:
- plan_id
- activity_type_id
- metadata
properties:
plan_id:
type: string
format: uuid
activity_type_id:
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
delay_count:
nullable: true
type: integer
format: int32
delay_unit:
nullable: true
type: string
user_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateMailActivityPlanTemplateRequest:
type: object
required:
- plan_id
- activity_type_id
- metadata
properties:
plan_id:
type: string
format: uuid
activity_type_id:
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
delay_count:
nullable: true
type: integer
format: int32
delay_unit:
nullable: true
type: string
user_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchMailActivityPlanTemplateRequest:
type: object
properties:
plan_id:
type: string
format: uuid
activity_type_id:
type: string
format: uuid
summary:
nullable: true
type: string
note:
nullable: true
type: string
delay_count:
nullable: true
type: integer
format: int32
delay_unit:
nullable: true
type: string
user_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailActivityPlanTemplateList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailActivityPlanTemplate'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailAliasDomain:
type: object
required:
- id
- name
- use_mx
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
catchall_alias:
nullable: true
type: string
bounce_alias:
nullable: true
type: string
bounce_alias_email:
nullable: true
type: string
catchall_alias_email:
nullable: true
type: string
use_mx:
type: boolean
mail_server_id:
nullable: true
type: string
format: uuid
from_filter:
nullable: true
type: string
metadata:
type: object
MailAliasDomainBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAliasDomain'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailAliasDomainRequest:
type: object
required:
- name
- use_mx
- metadata
properties:
name:
type: string
catchall_alias:
nullable: true
type: string
bounce_alias:
nullable: true
type: string
bounce_alias_email:
nullable: true
type: string
catchall_alias_email:
nullable: true
type: string
use_mx:
type: boolean
mail_server_id:
nullable: true
type: string
format: uuid
from_filter:
nullable: true
type: string
metadata:
type: object
UpdateMailAliasDomainRequest:
type: object
required:
- name
- use_mx
- metadata
properties:
name:
type: string
catchall_alias:
nullable: true
type: string
bounce_alias:
nullable: true
type: string
bounce_alias_email:
nullable: true
type: string
catchall_alias_email:
nullable: true
type: string
use_mx:
type: boolean
mail_server_id:
nullable: true
type: string
format: uuid
from_filter:
nullable: true
type: string
metadata:
type: object
PatchMailAliasDomainRequest:
type: object
properties:
name:
type: string
catchall_alias:
nullable: true
type: string
bounce_alias:
nullable: true
type: string
bounce_alias_email:
nullable: true
type: string
catchall_alias_email:
nullable: true
type: string
use_mx:
type: boolean
mail_server_id:
nullable: true
type: string
format: uuid
from_filter:
nullable: true
type: string
metadata:
type: object
MailAliasDomainList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAliasDomain'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailAlias:
type: object
required:
- id
- alias_contact
- metadata
properties:
id:
type: string
format: uuid
alias_name:
nullable: true
type: string
alias_domain_id:
nullable: true
type: string
format: uuid
alias_contact:
type: string
alias_model_id:
nullable: true
type: string
format: uuid
alias_parent_model_id:
nullable: true
type: string
format: uuid
alias_parent_thread_id:
nullable: true
type: string
format: uuid
alias_user_id:
nullable: true
type: string
format: uuid
alias_defaults:
nullable: true
type: string
alias_force_thread_id:
nullable: true
type: string
format: uuid
alias_reply_to_address:
nullable: true
type: string
metadata:
type: object
MailAliasBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAlias'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailAliasRequest:
type: object
required:
- alias_contact
- metadata
properties:
alias_name:
nullable: true
type: string
alias_domain_id:
nullable: true
type: string
format: uuid
alias_contact:
type: string
alias_model_id:
nullable: true
type: string
format: uuid
alias_parent_model_id:
nullable: true
type: string
format: uuid
alias_parent_thread_id:
nullable: true
type: string
format: uuid
alias_user_id:
nullable: true
type: string
format: uuid
alias_defaults:
nullable: true
type: string
alias_force_thread_id:
nullable: true
type: string
format: uuid
alias_reply_to_address:
nullable: true
type: string
metadata:
type: object
UpdateMailAliasRequest:
type: object
required:
- alias_contact
- metadata
properties:
alias_name:
nullable: true
type: string
alias_domain_id:
nullable: true
type: string
format: uuid
alias_contact:
type: string
alias_model_id:
nullable: true
type: string
format: uuid
alias_parent_model_id:
nullable: true
type: string
format: uuid
alias_parent_thread_id:
nullable: true
type: string
format: uuid
alias_user_id:
nullable: true
type: string
format: uuid
alias_defaults:
nullable: true
type: string
alias_force_thread_id:
nullable: true
type: string
format: uuid
alias_reply_to_address:
nullable: true
type: string
metadata:
type: object
PatchMailAliasRequest:
type: object
properties:
alias_name:
nullable: true
type: string
alias_domain_id:
nullable: true
type: string
format: uuid
alias_contact:
type: string
alias_model_id:
nullable: true
type: string
format: uuid
alias_parent_model_id:
nullable: true
type: string
format: uuid
alias_parent_thread_id:
nullable: true
type: string
format: uuid
alias_user_id:
nullable: true
type: string
format: uuid
alias_defaults:
nullable: true
type: string
alias_force_thread_id:
nullable: true
type: string
format: uuid
alias_reply_to_address:
nullable: true
type: string
metadata:
type: object
MailAliasList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAlias'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailAttachment:
type: object
required:
- id
- name
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
mimetype:
nullable: true
type: string
size:
nullable: true
type: integer
format: int32
datas:
nullable: true
type: string
checksum:
nullable: true
type: string
access_token:
nullable: true
type: string
format: uuid
owner_party_id:
nullable: true
type: string
format: uuid
owner_guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailAttachmentBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAttachment'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailAttachmentRequest:
type: object
required:
- name
- metadata
properties:
name:
type: string
mimetype:
nullable: true
type: string
size:
nullable: true
type: integer
format: int32
datas:
nullable: true
type: string
checksum:
nullable: true
type: string
access_token:
nullable: true
type: string
format: uuid
owner_party_id:
nullable: true
type: string
format: uuid
owner_guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateMailAttachmentRequest:
type: object
required:
- name
- metadata
properties:
name:
type: string
mimetype:
nullable: true
type: string
size:
nullable: true
type: integer
format: int32
datas:
nullable: true
type: string
checksum:
nullable: true
type: string
access_token:
nullable: true
type: string
format: uuid
owner_party_id:
nullable: true
type: string
format: uuid
owner_guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchMailAttachmentRequest:
type: object
properties:
name:
type: string
mimetype:
nullable: true
type: string
size:
nullable: true
type: integer
format: int32
datas:
nullable: true
type: string
checksum:
nullable: true
type: string
access_token:
nullable: true
type: string
format: uuid
owner_party_id:
nullable: true
type: string
format: uuid
owner_guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailAttachmentList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailAttachment'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessageAttachment:
type: object
required:
- id
- message_id
- attachment_id
- metadata
properties:
id:
type: string
format: uuid
message_id:
type: string
format: uuid
attachment_id:
type: string
format: uuid
metadata:
type: object
MailMessageAttachmentBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageAttachment'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageAttachmentRequest:
type: object
required:
- message_id
- attachment_id
- metadata
properties:
message_id:
type: string
format: uuid
attachment_id:
type: string
format: uuid
metadata:
type: object
UpdateMailMessageAttachmentRequest:
type: object
required:
- message_id
- attachment_id
- metadata
properties:
message_id:
type: string
format: uuid
attachment_id:
type: string
format: uuid
metadata:
type: object
PatchMailMessageAttachmentRequest:
type: object
properties:
message_id:
type: string
format: uuid
attachment_id:
type: string
format: uuid
metadata:
type: object
MailMessageAttachmentList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageAttachment'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessageStar:
type: object
required:
- id
- partner_id
- message_id
- metadata
properties:
id:
type: string
format: uuid
partner_id:
type: string
format: uuid
message_id:
type: string
format: uuid
metadata:
type: object
MailMessageStarBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageStar'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageStarRequest:
type: object
required:
- partner_id
- message_id
- metadata
properties:
partner_id:
type: string
format: uuid
message_id:
type: string
format: uuid
metadata:
type: object
UpdateMailMessageStarRequest:
type: object
required:
- partner_id
- message_id
- metadata
properties:
partner_id:
type: string
format: uuid
message_id:
type: string
format: uuid
metadata:
type: object
PatchMailMessageStarRequest:
type: object
properties:
partner_id:
type: string
format: uuid
message_id:
type: string
format: uuid
metadata:
type: object
MailMessageStarList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageStar'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessage:
type: object
required:
- id
- date
- body
- message_type
- is_internal
- needaction
- has_error
- metadata
properties:
id:
type: string
format: uuid
subject:
nullable: true
type: string
date:
type: string
format: date-time
body:
type: string
message_type:
type: string
subtype_id:
nullable: true
type: string
format: uuid
is_internal:
type: boolean
author_id:
nullable: true
type: string
format: uuid
author_guest_id:
nullable: true
type: string
format: uuid
email_from:
nullable: true
type: string
message_id:
nullable: true
type: string
reply_to:
nullable: true
type: string
model:
nullable: true
type: string
res_id:
nullable: true
type: string
format: uuid
record_name:
nullable: true
type: string
moderation_status:
nullable: true
type: string
needaction:
type: boolean
has_error:
type: boolean
failure_reason:
nullable: true
type: string
rating_value:
nullable: true
type: number
format: float
pinned_at:
nullable: true
type: string
format: date-time
metadata:
type: object
MailMessageBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessage'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageRequest:
type: object
required:
- date
- body
- message_type
- is_internal
- needaction
- has_error
- metadata
properties:
subject:
nullable: true
type: string
date:
type: string
format: date-time
body:
type: string
message_type:
type: string
subtype_id:
nullable: true
type: string
format: uuid
is_internal:
type: boolean
author_id:
nullable: true
type: string
format: uuid
author_guest_id:
nullable: true
type: string
format: uuid
email_from:
nullable: true
type: string
message_id:
nullable: true
type: string
reply_to:
nullable: true
type: string
model:
nullable: true
type: string
res_id:
nullable: true
type: string
format: uuid
record_name:
nullable: true
type: string
moderation_status:
nullable: true
type: string
needaction:
type: boolean
has_error:
type: boolean
failure_reason:
nullable: true
type: string
rating_value:
nullable: true
type: number
format: float
pinned_at:
nullable: true
type: string
format: date-time
metadata:
type: object
UpdateMailMessageRequest:
type: object
required:
- date
- body
- message_type
- is_internal
- needaction
- has_error
- metadata
properties:
subject:
nullable: true
type: string
date:
type: string
format: date-time
body:
type: string
message_type:
type: string
subtype_id:
nullable: true
type: string
format: uuid
is_internal:
type: boolean
author_id:
nullable: true
type: string
format: uuid
author_guest_id:
nullable: true
type: string
format: uuid
email_from:
nullable: true
type: string
message_id:
nullable: true
type: string
reply_to:
nullable: true
type: string
model:
nullable: true
type: string
res_id:
nullable: true
type: string
format: uuid
record_name:
nullable: true
type: string
moderation_status:
nullable: true
type: string
needaction:
type: boolean
has_error:
type: boolean
failure_reason:
nullable: true
type: string
rating_value:
nullable: true
type: number
format: float
pinned_at:
nullable: true
type: string
format: date-time
metadata:
type: object
PatchMailMessageRequest:
type: object
properties:
subject:
nullable: true
type: string
date:
type: string
format: date-time
body:
type: string
message_type:
type: string
subtype_id:
nullable: true
type: string
format: uuid
is_internal:
type: boolean
author_id:
nullable: true
type: string
format: uuid
author_guest_id:
nullable: true
type: string
format: uuid
email_from:
nullable: true
type: string
message_id:
nullable: true
type: string
reply_to:
nullable: true
type: string
model:
nullable: true
type: string
res_id:
nullable: true
type: string
format: uuid
record_name:
nullable: true
type: string
moderation_status:
nullable: true
type: string
needaction:
type: boolean
has_error:
type: boolean
failure_reason:
nullable: true
type: string
rating_value:
nullable: true
type: number
format: float
pinned_at:
nullable: true
type: string
format: date-time
metadata:
type: object
MailMessageList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessage'
meta:
$ref: '#/components/schemas/PaginationMeta'
Mail:
type: object
required:
- id
- mail_message_id
- state
- auto_delete
- headers
- metadata
properties:
id:
type: string
format: uuid
mail_message_id:
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
scheduled_date:
nullable: true
type: string
format: date-time
auto_delete:
type: boolean
failure_reason:
nullable: true
type: string
email_to:
nullable: true
type: string
email_cc:
nullable: true
type: string
reply_to:
nullable: true
type: string
headers:
type: object
metadata:
type: object
MailBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Mail'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailRequest:
type: object
required:
- mail_message_id
- state
- auto_delete
- headers
- metadata
properties:
mail_message_id:
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
scheduled_date:
nullable: true
type: string
format: date-time
auto_delete:
type: boolean
failure_reason:
nullable: true
type: string
email_to:
nullable: true
type: string
email_cc:
nullable: true
type: string
reply_to:
nullable: true
type: string
headers:
type: object
metadata:
type: object
UpdateMailRequest:
type: object
required:
- mail_message_id
- state
- auto_delete
- headers
- metadata
properties:
mail_message_id:
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
scheduled_date:
nullable: true
type: string
format: date-time
auto_delete:
type: boolean
failure_reason:
nullable: true
type: string
email_to:
nullable: true
type: string
email_cc:
nullable: true
type: string
reply_to:
nullable: true
type: string
headers:
type: object
metadata:
type: object
PatchMailRequest:
type: object
properties:
mail_message_id:
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
scheduled_date:
nullable: true
type: string
format: date-time
auto_delete:
type: boolean
failure_reason:
nullable: true
type: string
email_to:
nullable: true
type: string
email_cc:
nullable: true
type: string
reply_to:
nullable: true
type: string
headers:
type: object
metadata:
type: object
MailList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Mail'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailNotification:
type: object
required:
- id
- mail_message_id
- notification_type
- notification_status
- is_read
- metadata
properties:
id:
type: string
format: uuid
mail_message_id:
type: string
format: uuid
res_partner_id:
nullable: true
type: string
format: uuid
notification_type:
type: string
notification_status:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
mail_mail_id_int:
nullable: true
type: string
format: uuid
is_read:
type: boolean
metadata:
type: object
MailNotificationBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailNotification'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailNotificationRequest:
type: object
required:
- mail_message_id
- notification_type
- notification_status
- is_read
- metadata
properties:
mail_message_id:
type: string
format: uuid
res_partner_id:
nullable: true
type: string
format: uuid
notification_type:
type: string
notification_status:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
mail_mail_id_int:
nullable: true
type: string
format: uuid
is_read:
type: boolean
metadata:
type: object
UpdateMailNotificationRequest:
type: object
required:
- mail_message_id
- notification_type
- notification_status
- is_read
- metadata
properties:
mail_message_id:
type: string
format: uuid
res_partner_id:
nullable: true
type: string
format: uuid
notification_type:
type: string
notification_status:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
mail_mail_id_int:
nullable: true
type: string
format: uuid
is_read:
type: boolean
metadata:
type: object
PatchMailNotificationRequest:
type: object
properties:
mail_message_id:
type: string
format: uuid
res_partner_id:
nullable: true
type: string
format: uuid
notification_type:
type: string
notification_status:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
mail_mail_id_int:
nullable: true
type: string
format: uuid
is_read:
type: boolean
metadata:
type: object
MailNotificationList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailNotification'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessageSubtype:
type: object
required:
- id
- name
- internal
- default
- hidden
- tracked
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
description:
nullable: true
type: string
internal:
type: boolean
parent_id:
nullable: true
type: string
format: uuid
relation_field:
nullable: true
type: string
res_model:
nullable: true
type: string
default:
type: boolean
hidden:
type: boolean
tracked:
type: boolean
metadata:
type: object
MailMessageSubtypeBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageSubtype'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageSubtypeRequest:
type: object
required:
- name
- internal
- default
- hidden
- tracked
- metadata
properties:
name:
type: string
description:
nullable: true
type: string
internal:
type: boolean
parent_id:
nullable: true
type: string
format: uuid
relation_field:
nullable: true
type: string
res_model:
nullable: true
type: string
default:
type: boolean
hidden:
type: boolean
tracked:
type: boolean
metadata:
type: object
UpdateMailMessageSubtypeRequest:
type: object
required:
- name
- internal
- default
- hidden
- tracked
- metadata
properties:
name:
type: string
description:
nullable: true
type: string
internal:
type: boolean
parent_id:
nullable: true
type: string
format: uuid
relation_field:
nullable: true
type: string
res_model:
nullable: true
type: string
default:
type: boolean
hidden:
type: boolean
tracked:
type: boolean
metadata:
type: object
PatchMailMessageSubtypeRequest:
type: object
properties:
name:
type: string
description:
nullable: true
type: string
internal:
type: boolean
parent_id:
nullable: true
type: string
format: uuid
relation_field:
nullable: true
type: string
res_model:
nullable: true
type: string
default:
type: boolean
hidden:
type: boolean
tracked:
type: boolean
metadata:
type: object
MailMessageSubtypeList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageSubtype'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessageReaction:
type: object
required:
- id
- message_id
- content
- metadata
properties:
id:
type: string
format: uuid
message_id:
type: string
format: uuid
content:
type: string
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailMessageReactionBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageReaction'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageReactionRequest:
type: object
required:
- message_id
- content
- metadata
properties:
message_id:
type: string
format: uuid
content:
type: string
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateMailMessageReactionRequest:
type: object
required:
- message_id
- content
- metadata
properties:
message_id:
type: string
format: uuid
content:
type: string
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchMailMessageReactionRequest:
type: object
properties:
message_id:
type: string
format: uuid
content:
type: string
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailMessageReactionList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageReaction'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailFollowers:
type: object
required:
- id
- res_model
- res_id
- metadata
properties:
id:
type: string
format: uuid
res_model:
type: string
res_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
channel_id:
nullable: true
type: string
format: uuid
subtype_ids:
nullable: true
type: object
metadata:
type: object
MailFollowersBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailFollowers'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailFollowersRequest:
type: object
required:
- res_model
- res_id
- metadata
properties:
res_model:
type: string
res_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
channel_id:
nullable: true
type: string
format: uuid
subtype_ids:
nullable: true
type: object
metadata:
type: object
UpdateMailFollowersRequest:
type: object
required:
- res_model
- res_id
- metadata
properties:
res_model:
type: string
res_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
channel_id:
nullable: true
type: string
format: uuid
subtype_ids:
nullable: true
type: object
metadata:
type: object
PatchMailFollowersRequest:
type: object
properties:
res_model:
type: string
res_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
channel_id:
nullable: true
type: string
format: uuid
subtype_ids:
nullable: true
type: object
metadata:
type: object
MailFollowersList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailFollowers'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailPresence:
type: object
required:
- id
- status
- metadata
properties:
id:
type: string
format: uuid
user_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
status:
type: string
last_poll:
nullable: true
type: string
format: date-time
metadata:
type: object
MailPresenceBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailPresence'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailPresenceRequest:
type: object
required:
- status
- metadata
properties:
user_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
status:
type: string
last_poll:
nullable: true
type: string
format: date-time
metadata:
type: object
UpdateMailPresenceRequest:
type: object
required:
- status
- metadata
properties:
user_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
status:
type: string
last_poll:
nullable: true
type: string
format: date-time
metadata:
type: object
PatchMailPresenceRequest:
type: object
properties:
user_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
status:
type: string
last_poll:
nullable: true
type: string
format: date-time
metadata:
type: object
MailPresenceList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailPresence'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailBlacklist:
type: object
required:
- id
- email
- active
- metadata
properties:
id:
type: string
format: uuid
email:
type: string
opt_out_reason_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailBlacklistBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailBlacklist'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailBlacklistRequest:
type: object
required:
- email
- active
- metadata
properties:
email:
type: string
opt_out_reason_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
UpdateMailBlacklistRequest:
type: object
required:
- email
- active
- metadata
properties:
email:
type: string
opt_out_reason_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
PatchMailBlacklistRequest:
type: object
properties:
email:
type: string
opt_out_reason_id:
nullable: true
type: string
format: uuid
active:
type: boolean
metadata:
type: object
MailBlacklistList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailBlacklist'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailTrackingValue:
type: object
required:
- id
- mail_message_id
- field
- metadata
properties:
id:
type: string
format: uuid
mail_message_id:
type: string
format: uuid
field:
type: string
field_desc:
nullable: true
type: string
field_type:
nullable: true
type: string
old_value_integer:
nullable: true
type: integer
format: int32
old_value_float:
nullable: true
type: number
format: float
old_value_text:
nullable: true
type: string
old_value_datetime:
nullable: true
type: string
format: date-time
new_value_integer:
nullable: true
type: integer
format: int32
new_value_float:
nullable: true
type: number
format: float
new_value_text:
nullable: true
type: string
new_value_datetime:
nullable: true
type: string
format: date-time
currency_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailTrackingValueBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailTrackingValue'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailTrackingValueRequest:
type: object
required:
- mail_message_id
- field
- metadata
properties:
mail_message_id:
type: string
format: uuid
field:
type: string
field_desc:
nullable: true
type: string
field_type:
nullable: true
type: string
old_value_integer:
nullable: true
type: integer
format: int32
old_value_float:
nullable: true
type: number
format: float
old_value_text:
nullable: true
type: string
old_value_datetime:
nullable: true
type: string
format: date-time
new_value_integer:
nullable: true
type: integer
format: int32
new_value_float:
nullable: true
type: number
format: float
new_value_text:
nullable: true
type: string
new_value_datetime:
nullable: true
type: string
format: date-time
currency_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateMailTrackingValueRequest:
type: object
required:
- mail_message_id
- field
- metadata
properties:
mail_message_id:
type: string
format: uuid
field:
type: string
field_desc:
nullable: true
type: string
field_type:
nullable: true
type: string
old_value_integer:
nullable: true
type: integer
format: int32
old_value_float:
nullable: true
type: number
format: float
old_value_text:
nullable: true
type: string
old_value_datetime:
nullable: true
type: string
format: date-time
new_value_integer:
nullable: true
type: integer
format: int32
new_value_float:
nullable: true
type: number
format: float
new_value_text:
nullable: true
type: string
new_value_datetime:
nullable: true
type: string
format: date-time
currency_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchMailTrackingValueRequest:
type: object
properties:
mail_message_id:
type: string
format: uuid
field:
type: string
field_desc:
nullable: true
type: string
field_type:
nullable: true
type: string
old_value_integer:
nullable: true
type: integer
format: int32
old_value_float:
nullable: true
type: number
format: float
old_value_text:
nullable: true
type: string
old_value_datetime:
nullable: true
type: string
format: date-time
new_value_integer:
nullable: true
type: integer
format: int32
new_value_float:
nullable: true
type: number
format: float
new_value_text:
nullable: true
type: string
new_value_datetime:
nullable: true
type: string
format: date-time
currency_id:
nullable: true
type: string
format: uuid
metadata:
type: object
MailTrackingValueList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailTrackingValue'
meta:
$ref: '#/components/schemas/PaginationMeta'
DiscussChannel:
type: object
required:
- id
- channel_type
- email_send
- moderation
- metadata
properties:
id:
type: string
format: uuid
name:
nullable: true
type: string
channel_type:
type: string
description:
nullable: true
type: string
uuid:
nullable: true
type: string
default_access_mode:
nullable: true
type: string
avatar_128:
nullable: true
type: string
email_send:
type: boolean
moderation:
type: boolean
group_public_id:
nullable: true
type: string
format: uuid
alias_id:
nullable: true
type: string
format: uuid
last_message_id:
nullable: true
type: string
format: uuid
metadata:
type: object
DiscussChannelBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiscussChannel'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateDiscussChannelRequest:
type: object
required:
- channel_type
- email_send
- moderation
- metadata
properties:
name:
nullable: true
type: string
channel_type:
type: string
description:
nullable: true
type: string
uuid:
nullable: true
type: string
default_access_mode:
nullable: true
type: string
avatar_128:
nullable: true
type: string
email_send:
type: boolean
moderation:
type: boolean
group_public_id:
nullable: true
type: string
format: uuid
alias_id:
nullable: true
type: string
format: uuid
last_message_id:
nullable: true
type: string
format: uuid
metadata:
type: object
UpdateDiscussChannelRequest:
type: object
required:
- channel_type
- email_send
- moderation
- metadata
properties:
name:
nullable: true
type: string
channel_type:
type: string
description:
nullable: true
type: string
uuid:
nullable: true
type: string
default_access_mode:
nullable: true
type: string
avatar_128:
nullable: true
type: string
email_send:
type: boolean
moderation:
type: boolean
group_public_id:
nullable: true
type: string
format: uuid
alias_id:
nullable: true
type: string
format: uuid
last_message_id:
nullable: true
type: string
format: uuid
metadata:
type: object
PatchDiscussChannelRequest:
type: object
properties:
name:
nullable: true
type: string
channel_type:
type: string
description:
nullable: true
type: string
uuid:
nullable: true
type: string
default_access_mode:
nullable: true
type: string
avatar_128:
nullable: true
type: string
email_send:
type: boolean
moderation:
type: boolean
group_public_id:
nullable: true
type: string
format: uuid
alias_id:
nullable: true
type: string
format: uuid
last_message_id:
nullable: true
type: string
format: uuid
metadata:
type: object
DiscussChannelList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiscussChannel'
meta:
$ref: '#/components/schemas/PaginationMeta'
DiscussChannelMember:
type: object
required:
- id
- channel_id
- message_unread_counter
- unread_counter
- message_follower_counter
- is_pinned
- metadata
properties:
id:
type: string
format: uuid
channel_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
fold_state:
nullable: true
type: string
fetched_message_id:
nullable: true
type: string
format: uuid
new_message_separator:
nullable: true
type: string
format: uuid
custom_notifications:
nullable: true
type: string
mute_until_dt:
nullable: true
type: string
format: date-time
unpin_dt:
nullable: true
type: string
format: date-time
last_seen_dt:
nullable: true
type: string
format: date-time
message_unread_counter:
type: integer
format: int32
unread_counter:
type: integer
format: int32
message_follower_counter:
type: integer
format: int32
seen_message_id:
nullable: true
type: string
format: uuid
last_interest_dt:
nullable: true
type: string
format: date-time
is_pinned:
type: boolean
metadata:
type: object
DiscussChannelMemberBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiscussChannelMember'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateDiscussChannelMemberRequest:
type: object
required:
- channel_id
- message_unread_counter
- unread_counter
- message_follower_counter
- is_pinned
- metadata
properties:
channel_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
fold_state:
nullable: true
type: string
fetched_message_id:
nullable: true
type: string
format: uuid
new_message_separator:
nullable: true
type: string
format: uuid
custom_notifications:
nullable: true
type: string
mute_until_dt:
nullable: true
type: string
format: date-time
unpin_dt:
nullable: true
type: string
format: date-time
last_seen_dt:
nullable: true
type: string
format: date-time
message_unread_counter:
type: integer
format: int32
unread_counter:
type: integer
format: int32
message_follower_counter:
type: integer
format: int32
seen_message_id:
nullable: true
type: string
format: uuid
last_interest_dt:
nullable: true
type: string
format: date-time
is_pinned:
type: boolean
metadata:
type: object
UpdateDiscussChannelMemberRequest:
type: object
required:
- channel_id
- message_unread_counter
- unread_counter
- message_follower_counter
- is_pinned
- metadata
properties:
channel_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
fold_state:
nullable: true
type: string
fetched_message_id:
nullable: true
type: string
format: uuid
new_message_separator:
nullable: true
type: string
format: uuid
custom_notifications:
nullable: true
type: string
mute_until_dt:
nullable: true
type: string
format: date-time
unpin_dt:
nullable: true
type: string
format: date-time
last_seen_dt:
nullable: true
type: string
format: date-time
message_unread_counter:
type: integer
format: int32
unread_counter:
type: integer
format: int32
message_follower_counter:
type: integer
format: int32
seen_message_id:
nullable: true
type: string
format: uuid
last_interest_dt:
nullable: true
type: string
format: date-time
is_pinned:
type: boolean
metadata:
type: object
PatchDiscussChannelMemberRequest:
type: object
properties:
channel_id:
type: string
format: uuid
partner_id:
nullable: true
type: string
format: uuid
guest_id:
nullable: true
type: string
format: uuid
fold_state:
nullable: true
type: string
fetched_message_id:
nullable: true
type: string
format: uuid
new_message_separator:
nullable: true
type: string
format: uuid
custom_notifications:
nullable: true
type: string
mute_until_dt:
nullable: true
type: string
format: date-time
unpin_dt:
nullable: true
type: string
format: date-time
last_seen_dt:
nullable: true
type: string
format: date-time
message_unread_counter:
type: integer
format: int32
unread_counter:
type: integer
format: int32
message_follower_counter:
type: integer
format: int32
seen_message_id:
nullable: true
type: string
format: uuid
last_interest_dt:
nullable: true
type: string
format: date-time
is_pinned:
type: boolean
metadata:
type: object
DiscussChannelMemberList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiscussChannelMember'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailGuest:
type: object
required:
- id
- name
- active
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
country_id:
nullable: true
type: string
format: uuid
last_connection_dt:
nullable: true
type: string
format: date-time
active:
type: boolean
metadata:
type: object
MailGuestBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailGuest'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailGuestRequest:
type: object
required:
- name
- active
- metadata
properties:
name:
type: string
country_id:
nullable: true
type: string
format: uuid
last_connection_dt:
nullable: true
type: string
format: date-time
active:
type: boolean
metadata:
type: object
UpdateMailGuestRequest:
type: object
required:
- name
- active
- metadata
properties:
name:
type: string
country_id:
nullable: true
type: string
format: uuid
last_connection_dt:
nullable: true
type: string
format: date-time
active:
type: boolean
metadata:
type: object
PatchMailGuestRequest:
type: object
properties:
name:
type: string
country_id:
nullable: true
type: string
format: uuid
last_connection_dt:
nullable: true
type: string
format: date-time
active:
type: boolean
metadata:
type: object
MailGuestList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailGuest'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailServer:
type: object
required:
- id
- name
- smtp_host
- smtp_port
- smtp_authentication
- smtp_encryption
- smtp_debug
- sequence
- active
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
from_filter:
nullable: true
type: string
smtp_host:
type: string
smtp_port:
type: integer
format: int32
smtp_authentication:
type: string
smtp_user:
nullable: true
type: string
smtp_pass_ref:
nullable: true
type: string
smtp_encryption:
type: string
smtp_debug:
type: boolean
sequence:
type: integer
format: int32
active:
type: boolean
metadata:
type: object
MailServerBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailServer'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailServerRequest:
type: object
required:
- name
- smtp_host
- smtp_port
- smtp_authentication
- smtp_encryption
- smtp_debug
- sequence
- active
- metadata
properties:
name:
type: string
from_filter:
nullable: true
type: string
smtp_host:
type: string
smtp_port:
type: integer
format: int32
smtp_authentication:
type: string
smtp_user:
nullable: true
type: string
smtp_pass_ref:
nullable: true
type: string
smtp_encryption:
type: string
smtp_debug:
type: boolean
sequence:
type: integer
format: int32
active:
type: boolean
metadata:
type: object
UpdateMailServerRequest:
type: object
required:
- name
- smtp_host
- smtp_port
- smtp_authentication
- smtp_encryption
- smtp_debug
- sequence
- active
- metadata
properties:
name:
type: string
from_filter:
nullable: true
type: string
smtp_host:
type: string
smtp_port:
type: integer
format: int32
smtp_authentication:
type: string
smtp_user:
nullable: true
type: string
smtp_pass_ref:
nullable: true
type: string
smtp_encryption:
type: string
smtp_debug:
type: boolean
sequence:
type: integer
format: int32
active:
type: boolean
metadata:
type: object
PatchMailServerRequest:
type: object
properties:
name:
type: string
from_filter:
nullable: true
type: string
smtp_host:
type: string
smtp_port:
type: integer
format: int32
smtp_authentication:
type: string
smtp_user:
nullable: true
type: string
smtp_pass_ref:
nullable: true
type: string
smtp_encryption:
type: string
smtp_debug:
type: boolean
sequence:
type: integer
format: int32
active:
type: boolean
metadata:
type: object
MailServerList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailServer'
meta:
$ref: '#/components/schemas/PaginationMeta'
FetchmailServer:
type: object
required:
- id
- name
- active
- state
- priority
- token_hash
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
active:
type: boolean
state:
type: string
default_thread_model:
nullable: true
type: string
priority:
type: integer
format: int32
token_hash:
type: string
last_fetch_at:
nullable: true
type: string
format: date-time
error_at:
nullable: true
type: string
format: date-time
error_message:
nullable: true
type: string
metadata:
type: object
FetchmailServerBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/FetchmailServer'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateFetchmailServerRequest:
type: object
required:
- name
- active
- state
- priority
- token_hash
- metadata
properties:
name:
type: string
active:
type: boolean
state:
type: string
default_thread_model:
nullable: true
type: string
priority:
type: integer
format: int32
token_hash:
type: string
last_fetch_at:
nullable: true
type: string
format: date-time
error_at:
nullable: true
type: string
format: date-time
error_message:
nullable: true
type: string
metadata:
type: object
UpdateFetchmailServerRequest:
type: object
required:
- name
- active
- state
- priority
- token_hash
- metadata
properties:
name:
type: string
active:
type: boolean
state:
type: string
default_thread_model:
nullable: true
type: string
priority:
type: integer
format: int32
token_hash:
type: string
last_fetch_at:
nullable: true
type: string
format: date-time
error_at:
nullable: true
type: string
format: date-time
error_message:
nullable: true
type: string
metadata:
type: object
PatchFetchmailServerRequest:
type: object
properties:
name:
type: string
active:
type: boolean
state:
type: string
default_thread_model:
nullable: true
type: string
priority:
type: integer
format: int32
token_hash:
type: string
last_fetch_at:
nullable: true
type: string
format: date-time
error_at:
nullable: true
type: string
format: date-time
error_message:
nullable: true
type: string
metadata:
type: object
FetchmailServerList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/FetchmailServer'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailGatewayAllowed:
type: object
required:
- id
- pattern
- active
- metadata
properties:
id:
type: string
format: uuid
fetchmail_server_id:
nullable: true
type: string
format: uuid
pattern:
type: string
active:
type: boolean
metadata:
type: object
MailGatewayAllowedBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailGatewayAllowed'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailGatewayAllowedRequest:
type: object
required:
- pattern
- active
- metadata
properties:
fetchmail_server_id:
nullable: true
type: string
format: uuid
pattern:
type: string
active:
type: boolean
metadata:
type: object
UpdateMailGatewayAllowedRequest:
type: object
required:
- pattern
- active
- metadata
properties:
fetchmail_server_id:
nullable: true
type: string
format: uuid
pattern:
type: string
active:
type: boolean
metadata:
type: object
PatchMailGatewayAllowedRequest:
type: object
properties:
fetchmail_server_id:
nullable: true
type: string
format: uuid
pattern:
type: string
active:
type: boolean
metadata:
type: object
MailGatewayAllowedList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailGatewayAllowed'
meta:
$ref: '#/components/schemas/PaginationMeta'
PhoneBlacklist:
type: object
required:
- id
- number
- active
- metadata
properties:
id:
type: string
format: uuid
number:
type: string
active:
type: boolean
metadata:
type: object
PhoneBlacklistBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PhoneBlacklist'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreatePhoneBlacklistRequest:
type: object
required:
- number
- active
- metadata
properties:
number:
type: string
active:
type: boolean
metadata:
type: object
UpdatePhoneBlacklistRequest:
type: object
required:
- number
- active
- metadata
properties:
number:
type: string
active:
type: boolean
metadata:
type: object
PatchPhoneBlacklistRequest:
type: object
properties:
number:
type: string
active:
type: boolean
metadata:
type: object
PhoneBlacklistList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PhoneBlacklist'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailMessageSchedule:
type: object
required:
- id
- mail_message_id
- scheduled_datetime
- metadata
properties:
id:
type: string
format: uuid
mail_message_id:
type: string
format: uuid
notification_parameters:
nullable: true
type: string
scheduled_datetime:
type: string
format: date-time
metadata:
type: object
MailMessageScheduleBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageSchedule'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailMessageScheduleRequest:
type: object
required:
- mail_message_id
- scheduled_datetime
- metadata
properties:
mail_message_id:
type: string
format: uuid
notification_parameters:
nullable: true
type: string
scheduled_datetime:
type: string
format: date-time
metadata:
type: object
UpdateMailMessageScheduleRequest:
type: object
required:
- mail_message_id
- scheduled_datetime
- metadata
properties:
mail_message_id:
type: string
format: uuid
notification_parameters:
nullable: true
type: string
scheduled_datetime:
type: string
format: date-time
metadata:
type: object
PatchMailMessageScheduleRequest:
type: object
properties:
mail_message_id:
type: string
format: uuid
notification_parameters:
nullable: true
type: string
scheduled_datetime:
type: string
format: date-time
metadata:
type: object
MailMessageScheduleList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailMessageSchedule'
meta:
$ref: '#/components/schemas/PaginationMeta'
MailScheduledMessage:
type: object
required:
- id
- body
- scheduled_date
- model
- res_id
- author_party_id
- is_note
- metadata
properties:
id:
type: string
format: uuid
subject:
nullable: true
type: string
body:
type: string
scheduled_date:
type: string
format: date-time
composition_comment_option:
nullable: true
type: string
model:
type: string
res_id:
type: string
format: uuid
author_party_id:
type: string
format: uuid
recipient_party_ids:
nullable: true
type: object
is_note:
type: boolean
notification_parameters:
nullable: true
type: string
send_context:
nullable: true
type: object
metadata:
type: object
MailScheduledMessageBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailScheduledMessage'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateMailScheduledMessageRequest:
type: object
required:
- body
- scheduled_date
- model
- res_id
- author_party_id
- is_note
- metadata
properties:
subject:
nullable: true
type: string
body:
type: string
scheduled_date:
type: string
format: date-time
composition_comment_option:
nullable: true
type: string
model:
type: string
res_id:
type: string
format: uuid
author_party_id:
type: string
format: uuid
recipient_party_ids:
nullable: true
type: object
is_note:
type: boolean
notification_parameters:
nullable: true
type: string
send_context:
nullable: true
type: object
metadata:
type: object
UpdateMailScheduledMessageRequest:
type: object
required:
- body
- scheduled_date
- model
- res_id
- author_party_id
- is_note
- metadata
properties:
subject:
nullable: true
type: string
body:
type: string
scheduled_date:
type: string
format: date-time
composition_comment_option:
nullable: true
type: string
model:
type: string
res_id:
type: string
format: uuid
author_party_id:
type: string
format: uuid
recipient_party_ids:
nullable: true
type: object
is_note:
type: boolean
notification_parameters:
nullable: true
type: string
send_context:
nullable: true
type: object
metadata:
type: object
PatchMailScheduledMessageRequest:
type: object
properties:
subject:
nullable: true
type: string
body:
type: string
scheduled_date:
type: string
format: date-time
composition_comment_option:
nullable: true
type: string
model:
type: string
res_id:
type: string
format: uuid
author_party_id:
type: string
format: uuid
recipient_party_ids:
nullable: true
type: object
is_note:
type: boolean
notification_parameters:
nullable: true
type: string
send_context:
nullable: true
type: object
metadata:
type: object
MailScheduledMessageList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MailScheduledMessage'
meta:
$ref: '#/components/schemas/PaginationMeta'
Sms:
type: object
required:
- id
- uuid
- number
- body
- state
- metadata
properties:
id:
type: string
format: uuid
uuid:
type: string
number:
type: string
body:
type: string
state:
type: string
failure_type:
nullable: true
type: string
error_message:
nullable: true
type: string
mail_message_id:
nullable: true
type: string
format: uuid
iap_status_code:
nullable: true
type: integer
format: int32
metadata:
type: object
SmsBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Sms'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateSmsRequest:
type: object
required:
- uuid
- number
- body
- state
- metadata
properties:
uuid:
type: string
number:
type: string
body:
type: string
state:
type: string
failure_type:
nullable: true
type: string
error_message:
nullable: true
type: string
mail_message_id:
nullable: true
type: string
format: uuid
iap_status_code:
nullable: true
type: integer
format: int32
metadata:
type: object
UpdateSmsRequest:
type: object
required:
- uuid
- number
- body
- state
- metadata
properties:
uuid:
type: string
number:
type: string
body:
type: string
state:
type: string
failure_type:
nullable: true
type: string
error_message:
nullable: true
type: string
mail_message_id:
nullable: true
type: string
format: uuid
iap_status_code:
nullable: true
type: integer
format: int32
metadata:
type: object
PatchSmsRequest:
type: object
properties:
uuid:
type: string
number:
type: string
body:
type: string
state:
type: string
failure_type:
nullable: true
type: string
error_message:
nullable: true
type: string
mail_message_id:
nullable: true
type: string
format: uuid
iap_status_code:
nullable: true
type: integer
format: int32
metadata:
type: object
SmsList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Sms'
meta:
$ref: '#/components/schemas/PaginationMeta'
SmsTemplate:
type: object
required:
- id
- name
- body
- active
- metadata
properties:
id:
type: string
format: uuid
name:
type: string
body:
type: string
model_id:
nullable: true
type: string
format: uuid
lang:
nullable: true
type: string
condition:
nullable: true
type: string
active:
type: boolean
metadata:
type: object
SmsTemplateBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SmsTemplate'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateSmsTemplateRequest:
type: object
required:
- name
- body
- active
- metadata
properties:
name:
type: string
body:
type: string
model_id:
nullable: true
type: string
format: uuid
lang:
nullable: true
type: string
condition:
nullable: true
type: string
active:
type: boolean
metadata:
type: object
UpdateSmsTemplateRequest:
type: object
required:
- name
- body
- active
- metadata
properties:
name:
type: string
body:
type: string
model_id:
nullable: true
type: string
format: uuid
lang:
nullable: true
type: string
condition:
nullable: true
type: string
active:
type: boolean
metadata:
type: object
PatchSmsTemplateRequest:
type: object
properties:
name:
type: string
body:
type: string
model_id:
nullable: true
type: string
format: uuid
lang:
nullable: true
type: string
condition:
nullable: true
type: string
active:
type: boolean
metadata:
type: object
SmsTemplateList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SmsTemplate'
meta:
$ref: '#/components/schemas/PaginationMeta'
SmsTracker:
type: object
required:
- id
- sms_uuid
- state
- metadata
properties:
id:
type: string
format: uuid
sms_uuid:
type: string
message_id:
nullable: true
type: string
format: uuid
notification_id:
nullable: true
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
recipient:
nullable: true
type: string
metadata:
type: object
SmsTrackerBulkResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SmsTracker'
total: { type: integer }
failed: { type: integer }
errors:
type: array
items: { type: string }
CreateSmsTrackerRequest:
type: object
required:
- sms_uuid
- state
- metadata
properties:
sms_uuid:
type: string
message_id:
nullable: true
type: string
format: uuid
notification_id:
nullable: true
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
recipient:
nullable: true
type: string
metadata:
type: object
UpdateSmsTrackerRequest:
type: object
required:
- sms_uuid
- state
- metadata
properties:
sms_uuid:
type: string
message_id:
nullable: true
type: string
format: uuid
notification_id:
nullable: true
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
recipient:
nullable: true
type: string
metadata:
type: object
PatchSmsTrackerRequest:
type: object
properties:
sms_uuid:
type: string
message_id:
nullable: true
type: string
format: uuid
notification_id:
nullable: true
type: string
format: uuid
state:
type: string
failure_type:
nullable: true
type: string
failure_reason:
nullable: true
type: string
recipient:
nullable: true
type: string
metadata:
type: object
SmsTrackerList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SmsTracker'
meta:
$ref: '#/components/schemas/PaginationMeta'
PaginationMeta:
type: object
properties:
total:
type: integer
example: 100
page:
type: integer
example: 1
per_page:
type: integer
example: 20
total_pages:
type: integer
example: 5
Error:
type: object
required:
- code
- message
properties:
code:
type: string
example: VALIDATION_ERROR
message:
type: string
example: Invalid input data
details:
type: object
additionalProperties: true
parameters:
IdParam:
name: id
in: path
required: true
schema:
type: string
format: uuid
PageParam:
name: page
in: query
schema:
type: integer
minimum: 1
default: 1
PerPageParam:
name: per_page
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
SortByParam:
name: sort_by
in: query
schema:
type: string
SortOrderParam:
name: sort_order
in: query
schema:
type: string
enum: [asc, desc]
default: asc
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBodies:
BatchIds:
required: true
content:
application/json:
schema:
type: object
required: [ids]
properties:
ids:
type: array
items: { type: string }
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []