KIO Link
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
  1. Comunicados
  • Auth
    • Overview
    • Log in
    • Send a one-time sign-in token
    • Log in with Apple
    • Validate a session token
    • Sign in with a one-time sign-in token
    • Request a password reset
    • Get the user of a password reset token
    • Reset a password
    • Submit a business registration request
    • Enable two-factor authentication
    • Confirm a two-factor login
  • Application Content
    • List application content
    • Create application content
    • Get application content by slug
    • Get application content by public id
    • Partially update application content
    • Delete application content
  • Businesses
    • Overview
    • Business Users
      • Overview
      • List business users by business
      • List a business's users
      • Create a business user
      • Get a business user
      • Update a business user
      • Upload a business user's avatar
      • Delete a business user's avatar
      • Deactivate business users
      • Search business users
      • Search a business's users
      • Send a password reset email to a business user
      • Reset a business user's daily sign-in code limits
      • Toggle a business user's two-factor authentication
      • Import business users from CSV
      • Export all business users
      • Set whether I receive releases
      • Set whether I receive alerts
      • Request the deletion of my account
    • Business Roles
      • Overview
      • List business user roles
      • Create a business user role
      • Get a business user role
      • Update a business user role
      • Delete a business user role
    • Business Permissions
      • Overview
      • List business user permissions
      • Create a business user permission
      • Delete a business user permission
    • Business Consoles
      • Overview
      • List a business's consoles
      • Create a business console
      • Delete a business console
    • Business Devices
      • Overview
      • List a business's devices
      • Search a business's devices
      • Export all business devices
      • Export my business's devices
      • Import business devices from CSV
      • Start device transfers from CSV
      • Import device statuses from CSV
      • Delete business devices
      • Change a device's owner
      • Get a business's device transfer log
    • Business Racks
      • Overview
      • Export all business racks
      • Assign a rack to a business
      • List a business's racks
      • List all business racks
      • Change a business rack's status
      • Delete business racks
      • Restore a deleted business rack
      • Import business racks from CSV
    • Business Locations
      • Overview
      • Update a business's status and datacenters
      • Migrate business locations to datacenters
      • Remove the old locations field from businesses
      • Migrate business user locations to datacenters
      • Migrate business device locations to datacenter names
    • Business Reports
      • Overview
      • Send the visits reports
      • Download a visits report
      • Set a business's report recipients
    • List businesses
    • Search businesses
    • Search businesses by name or extra data
    • Export businesses
    • Get a business
    • Create a business
    • Import businesses from CSV
    • Update a business
    • Delete a business
  • Banned Devices
    • List banned devices
    • Check if a device is risky or banned
    • Get a banned device
    • Create a banned device
    • Update a banned device
    • Delete a banned device
  • Comunicados
    • Overview
    • Comunicado Templates
      • Overview
      • List comunicado templates
      • Create a comunicado template
      • Get a comunicado template
      • Update a comunicado template
      • Delete a comunicado template
    • List comunicados
      GET
    • Create a comunicado
      POST
    • Get a comunicado
      GET
    • Update a comunicado
      PATCH
    • Delete a comunicado
      DELETE
    • Send a comunicado now
      GET
    • Find comunicado recipients
      POST
    • View a comunicado I received
      GET
    • Send programmed comunicados
      GET
    • Send today's movements to Domo
      GET
  • External Users
    • Overview
    • List external users
    • Find external users to invite
    • Search external users
    • Export external users
    • Create an external user
    • Edit an external user
    • Update an external user
    • Upload an external user's avatar
    • Delete an external user's avatar
    • Delete an external user
  • Files
    • Overview
    • Business Files
      • Overview
      • Get a business's directory tree
      • Create a directory
      • Delete a directory
      • Highlight a directory in MyKIO
      • Stop highlighting a directory in MyKIO
      • List a business's files
      • Upload a file
      • Delete a file
      • Download a business file
    • Event Files
      • Overview
      • Attach files to a event
      • Remove a file from a event
      • Download a event file
    • Pre-Event Files
      • Overview
      • Attach files to a pre-event
      • Remove a file from a pre-event
      • Download a pre-event file
    • Public Assets
      • Overview
      • Get a user avatar
      • Get an incident file
      • Get an asset photo
      • Get an external user avatar
      • Download a template file
      • Get an extra file
      • Get a business logo
      • Get a tutorial PDF
      • Get a tutorial image
  • Forgotten Badges
    • Overview
    • List forgotten badge reports
    • List my forgotten badge reports
    • Report a forgotten badge
    • Delete a forgotten badge report
  • Infrastructure
    • Overview
    • Electrical Catalogs
      • Overview
      • List Voltages
      • Create a voltage
      • Update a voltage
      • Delete a voltage
      • List STSs
      • Create a sts
      • Delete a sts
      • List Regleta PDUs
      • Create a regleta pdu
      • Delete a regleta pdu
      • List Receptacle PDUs
      • Create a receptacle pdu
      • Delete a receptacle pdu
    • Cabling Catalogs
      • Overview
      • List Wires
      • Create a wire
      • Update a wire
      • Delete a wire
      • List Carriers
      • Create a carrier
      • Delete a carrier
    • Salesforce Products
      • Overview
      • List Salesforce products
      • List Salesforce products by product line
      • Create a Salesforce product
      • Update a Salesforce product
      • Delete a Salesforce product
    • Event Types
      • Overview
      • Create event types
      • Migrate event type locations
      • List event authorizations
      • Create an event authorization
      • Get an event authorization
      • Update an event authorization
      • Delete an event authorization
    • Data Centers
      • Overview
      • List datacenters
      • Create a datacenter
      • Update a datacenter
      • Delete a datacenter
    • Get every infrastructure catalog
    • Migrate device type forms
  • Intake Forms
    • List intake form reponses
    • Get an intake form's response
    • Get an intake form's response license file
    • Get an intake form's response identification file
    • Download intake form responses report
    • Create an intake form's response
    • Upload a license file to an intake form's response
    • Upload an identification file to an intake form's response
    • Update an intake form's response
    • Delete an intake form's response
  • My Business
    • Overview
    • My Business Users
      • Overview
      • List my business's users
      • Add a user to my business
      • Get a user of my business
      • Update a user of my business
      • Deactivate users of my business
      • Send a password reset email to a user of my business
    • My Account
      • Overview
      • Get my account
      • Change my password
      • Add one of my personal devices
      • Remove one of my personal devices
    • My Datacenter Access
      • Overview
      • List my pending datacenter access requests
      • Request datacenter access
      • List my business's pending datacenter access requests
      • Authorize a datacenter access request
      • Reject a datacenter access request
    • My Business Devices
      • Overview
      • List my business's devices
      • Search my business's devices
      • Get a device of my business
      • Register a device
      • Update a device
      • Delete devices of my business
      • Request a device status change
      • List my business's racks in a location
      • Start device transfers
      • Receive a transferred device
      • Receive transferred devices from CSV
      • Get my business's device transfer log
    • My Business KPIs
      • Overview
      • Get my business's KPI history
      • Get my business's latest KPI values
    • My Files
      • Overview
      • Get my directory tree
      • Create a directory in my files
      • Delete a directory from my files
      • List my highlighted directories
      • List my files
      • Upload a file to my files
      • Delete a file from my files
    • Get my business
    • Update my business
    • List business user roles
    • List my business's consoles
  • Users
    • Overview
    • Permissions
      • Overview
      • Generate KIO user permissions
      • Generate business user permissions
      • List KIO user permissions
      • Create a KIO user permission
      • Delete a KIO user permission
    • Roles
      • Overview
      • List KIO user roles
      • Create a KIO user role
      • Get a KIO user role
      • Update a KIO user role
      • Delete a KIO user role
    • User Groups
      • Overview
      • List user groups
      • Create a user group
      • Update a user group
      • Delete a user group
    • List KIO users
    • Create a KIO user
    • Get a KIO user
    • Update a KIO user
    • Activate or deactivate a KIO user
    • Delete a KIO user
    • Generate a session token for a user
    • Export KIO users
    • Search active KIO users by name
    • Search KIO users
    • Look up an employee in SuccessFactors
    • Import KIO user updates from CSV
  • MyKIO
    • Overview
    • Get my monitored servers
    • Get a server's probes
    • Get a server's ping history
    • Get a server's ping history for a time window
    • Get a server's CPU, memory and disk usage
    • Get a server's CPU, memory and disk usage for a time window
    • Get my network devices
    • List Spectrum device types
    • Get my ticket volume
    • Get my tickets
    • Get my monitored links
  • KIO Link
    • Overview
    • Visits
      • Overview
      • List my visits
      • List my visits in a date range
      • List visits I organized
      • List my upcoming visits
      • List my visit history
      • List my cancelled and rejected visits
      • Find a visit by folio
      • Get a visit
      • Create a visit
      • Update a visit
      • Delete a visit
      • Cancel a visit
      • Assign an engineer to a visit
      • Comment on a visit
      • Edit a visit comment
      • List built-in visit types
      • Get the authorization SLA settings
      • Get the visit length settings
      • Search client businesses for a visit
      • Record a QR download
      • Send authorization escalations
    • Visit Authorization
      • Overview
      • List visits waiting for my authorization
      • Get a visit's authorization line
      • Authorize a visit
      • Reject a visit
      • Cancel an authorized visit
      • Answer a rack opening request
    • Visit Access Control
      • Overview
      • List today's visits at my locations
      • Read a guest QR code
      • Check a KIO user QR code
      • Register a KIO user movement
      • Register a guest entry
      • Register a guest exit
      • Register a personal device entry
      • Register a personal device exit
      • List a visit's business devices from a QR
      • Register a business device movement
      • Get a guest QR image
      • List today's badge print requests
      • Delete a badge print request
    • Visit Devices
      • Overview
      • Get a business device
      • Edit a business device
      • Approve a device status change request
      • Reject a device status change request
    • Package Deliveries
      • Overview
      • List package notes of a delivery
      • Add a package note
      • Get a package note photo
    • Pre-Visits
      • Overview
      • List pre-visits to authorize
      • Get a pre-visit
      • Authorize a pre-visit
      • Reject a pre-visit
      • Cancel a pre-visit
      • Update a pre-visit
    • COVID
      • Overview
      • Check a COVID questionnaire link
      • Answer the COVID questionnaire
      • Get a questionnaire
      • Get a user's latest COVID answers
      • Update the COVID questionnaire weights
      • Migrate COVID answers
      • Generate a COVID questionnaire link
      • Unban a user
      • Check available places
      • Set vaccine and disclaimer validity
      • Get vaccine and disclaimer validity
      • Register a vaccination
      • Get the COVID information texts
      • Update the COVID information texts
    • Feedback
      • Overview
      • Send app feedback
      • Send service feedback
  • Send App Notification
    POST
  • Events Locations
    GET
  • Schemas
    • Auth
      • Auth Session
      • Two-Factor Status
      • Two-Factor Challenge
      • KIO User Session
    • Businesses
      • Business Users
        • Business User Role
        • Datacenter Access
        • Business User
        • Business User With Relations
        • Business User Permission
      • Business Devices
        • Business Device
        • Business Device Log Entry
        • Device Movement
        • Device Type
        • Business Device With Relations
      • Business Racks
        • Business Rack
        • Datacenter Rack
      • Business
      • Datacenter Assignment
      • Business List Item
      • Business Console
    • Comunicados
      • Comunicado Template
      • Comunicado
    • External Users
      • External User
    • Files
      • Attached File
      • Directory
      • Directory Tree Node
      • Business File
    • Forgotten Badges
      • Forgotten Badge
    • Infrastructure
      • Named Catalog Item
      • Voltage
      • Wire
      • Salesforce Product
      • Event Authorization
      • Event Type
    • Users
      • User Role
      • User
      • User Permission
      • User Group
      • Permission Catalog
      • SuccessFactors Employee
    • MyKIO
      • Monitoring Response
      • Spectrum Device Type
    • KIO Link
      • Visit Movement
      • Visit Device
      • Visit Invitation
      • KIO User Invitation
      • Business User Invitation
      • External User Invitation
      • Authorization Stamp
      • Visit Rejection
      • Visit Comment
      • Visit
      • Pre-Visit
      • Person Summary
      • Visit With People
      • Pre-Visit With People
      • Visit Authorizer
      • Visit Type Definition
      • Package Comment
    • COVID
      • COVID Questionnaire
      • COVID Answers
      • Vaccine Record
      • Vaccine Expiration
      • COVID Information
    • ApplicationContentCreate
    • ApplicationContentUpdate
    • ApplicationContent
    • ApplicationContentListResponse
    • Banned Device
    • Error
    • LanguageEntry
    • Pagination
    • Intake Form
    • DataCenter
    • LocalizedContent
    • Delete Result
    • Import Row Error
    • Bulk Write Result
    • Message
    • Personal Device
    • Update Result
  1. Comunicados

Overview

Comunicados#

Releases (comunicados): messages that KIO sends to client business users, and optionally to other email addresses, by email and app notification.

Concepts#

Comunicado: a subject, description and content rendered with an HTML template (see the Comunicado Templates subfolder).
Recipients: _business_users (picked with Find comunicado recipients by location, phase, role and language) and external_emails. Deactivated business users are removed from every comunicado.
Sending: immediately with Send a comunicado now, or automatically at each of its programmed_dates, sent by a scheduler that calls Send programmed comunicados. Business users also get an app notification and can open the comunicado in the app.
Visibility: KIO users with comunicados-items-get see every comunicado; others see the ones they created or that target their locations.
Domo: Send today's movements to Domo lives in this router but is unrelated to comunicados: it exports today's datacenter entries and exits.
The two cron endpoints are public and rely on secret paths.

Subfolders#

Comunicado Templates: email templates.

Endpoints#

List comunicados#

GET /v1/comunicados/item
Comunicados visible to the user, with recipient counts.

Create a comunicado#

POST /v1/comunicados/item
Creates a comunicado.

Get a comunicado#

GET /v1/comunicados/item/{id}
Returns a comunicado.

Update a comunicado#

PATCH /v1/comunicados/item/{id}
Updates a comunicado.

Delete a comunicado#

DELETE /v1/comunicados/item/{id}
Deletes a comunicado.

Send a comunicado now#

GET /v1/comunicados/item/{id}/launch
Sends a comunicado now.

Find comunicado recipients#

POST /v1/comunicados/business-users/search
Business users that match location, role and language filters.

View a comunicado I received#

GET /v1/comunicados/businessitem/{id}
A received comunicado, rendered for the business user.

Send programmed comunicados#

GET /v1/comunicados/cron/19kn977LmV36d1H0r1Q0Jk9xJd63243Q
Sends the comunicados programmed for now (scheduler).

Send today's movements to Domo#

GET /v1/comunicados/cron/domo/Y2hyb25lX2RvbW9fMDdfMDRfMjAyMQ
Emails today's movements CSV to Domo (scheduler).

Source#

Router: routes/v1/comunicados.js
Controller: controllers/comunicados.js
Model: models/comunicado.js
Services: services/notification.js, services/mailing.js
Modified at 2026-10-05 22:17:25
Previous
Delete a banned device
Next
Overview
Built with