Everbridge Template Category APIs API

openapi: 3.2.0
info:
  title: Communications Template Category APIs API
  description: Unified Communications APIs
  version: '1.0'
servers:
- url: https://api.everbridge.net/managerapps/communications/v1
tags:
- name: Template Category APIs
paths:
  /templates/categories:
    get:
      tags:
      - Template Category APIs
      operationId: getTemplateCategories
      summary: List categories
      description: List available Categories.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filters by the name of the category. Returns any category that contains any word provided in `name` by default.
      - in: query
        name: exactName
        schema:
          type: boolean
        description: Filters by the name of the category.Returns the category match the name.
      - in: query
        name: nonEmpty
        schema:
          type: boolean
        description: If provided and set to true, the API will only return categories that have at least one template associated with them. If not provided or set to false, all categories will be returned regardless of whether they have templates associated with them.
      - in: query
        name: sortBy
        schema:
          type: string
          enum:
          - CREATED
          - UPDATED
          - NAME
        description: 'The field to sort the result set by. See `sortDirection` for adjusting the order in which the result set is sorted.

          Defaults to `CREATED`.'
      - in: query
        name: sortDirection
        schema:
          type: string
          enum:
          - ASC
          - ASCENDING
          - DESC
          - DESCENDING
        description: 'The order by which to sort the result set by. `ASC` and `ASCENDING` have the same effect of ordering the values in ascending order; additionally, `DESC` and `DESCENDING` also have the same effect of ordering the values in descending order. See `sortBy` for details on changing which field is used in sorting.

          Defaults to `DESCENDING`.'
      - in: query
        name: pageSize
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
        description: The size of each page of search results. Defaults to ten records.
      - in: query
        name: pageNumber
        schema:
          type: integer
          format: int32
          minimum: 1
        description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 1.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryApiPaginatedResponse'
        '400':
          description: 'Invalid value for: header Authorization, Invalid value for: parameters'
          content:
            text/plain:
              schema:
                type: string
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: GET
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/templates/categories
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    head:
      tags:
      - Template Category APIs
      operationId: Check matched category exist or not
      summary: query categories
      description: Check matched category exist or not.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filters by the name of the category. Returns 200 if any word provided in `name` by default.
      - in: query
        name: exactName
        schema:
          type: boolean
        description: Filters by the name of the category.Returns 200 if any word match the category name.
      - in: query
        name: organizationWide
        schema:
          type: boolean
        description: If true, checks for matching categories across the entire organization (ignores per-category read visibility). Defaults to false.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
        '400':
          description: 'Invalid value for: header Authorization, Invalid value for: parameters'
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: There are not matched categories
          content:
            text/plain:
              schema:
                type: string
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: HEAD
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/templates/categories
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    post:
      tags:
      - Template Category APIs
      operationId: addCategory
      summary: Add Category
      description: Add a new category.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateCreateAndUpdateRequest'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommsResponse'
        '400':
          description: 'Invalid value for: header Authorization, Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: POST
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/templates/categories
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
  /templates/categories/{categoryId}:
    patch:
      tags:
      - Template Category APIs
      operationId: updateCategory
      summary: Update Category
      description: Updates an existing category.
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommsResponse'
        '400':
          description: Invalid body or categoryId
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: resource could not be found
          content:
            text/plain:
              schema:
                type: string
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: PATCH
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/templates/categories/{categoryId}
        responses:
          default:
            statusCode: '202'
        requestParameters:
          integration.request.path.categoryId: method.request.path.categoryId
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    delete:
      tags:
      - Template Category APIs
      operationId: deleteCategory
      summary: delete Category
      description: Delete an existing category.
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommsResponse'
        '400':
          description: Invalid body or categoryId
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: resource could not be found
          content:
            text/plain:
              schema:
                type: string
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: DELETE
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/templates/categories/{categoryId}
        responses:
          default:
            statusCode: '202'
        requestParameters:
          integration.request.path.categoryId: method.request.path.categoryId
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
components:
  schemas:
    CategoryApiPaginatedResponse:
      type: object
      description: A page of data from an endpoint.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CategoryBase'
        pages:
          type: object
          properties:
            currentPage:
              type: number
              description: The requested page number.
            pageSize:
              type: number
              description: The requested page size.
            pageCount:
              type: number
              description: The number of elements in the current page.
            totalPages:
              type: number
              description: The total number of pages available for request.
            maxSize:
              type: number
              description: The maximum size of a single page that is allowed by the API.
            totalCount:
              type: number
              description: The total number of elements across all pages.
    MessageContent:
      required:
      - contents
      type: object
      description: Notification message content that is included within the communication. If a `templateId` is present, this value becomes optional and will override the template's message content if provided.
      properties:
        conferenceBridgeId:
          type: string
          description: The ID of a conference bridge for recipients to join. Retrieve conference bridge IDs from the [Everbridge List Conference Bridges API](https://developers.everbridge.net/internal/reference/ebs-list-conference-bridges). Note that this property is mutually exclusive with `questionnaire`; both may not be set in the same communication.
        questionnaire:
          type: object
          description: A list of answers to a provided question for recipients to respond with during confirmation. Note that this property is mutually exclusive with `conferenceBridgeId`; both may not be set in the same communication.
          required:
          - answers
          properties:
            answers:
              type: array
              items:
                type: object
                required:
                - name
                properties:
                  name:
                    type: string
                    description: The user-friendly text of the questionnaire answer.
                  responseQuota:
                    type: integer
                    description: Defines a minimum number of recipients that must respond with this questionnaire answer.
            questionText:
              type: string
              description: The text prompt to display to recipients when they are responding to the questionnaire.
        contents:
          type: array
          description: The bodies of the notification message shown to recipients. There may be multiple `Textual` message bodies but at most one `Audio` message body and/or at most one `WebPage` message body.
          items:
            anyOf:
            - $ref: '#/components/schemas/AudioMessageBody'
            - $ref: '#/components/schemas/TextualMessageBody'
            - $ref: '#/components/schemas/WebPageMessageBody'
    AudioBulletinBoardPublicMessage:
      type: object
      description: The ABB public message content.
      required:
      - title
      - body
      - settingId
      properties:
        title:
          type: string
          description: The title of abb.
        body:
          type: string
          description: The core content of abb.
        settingId:
          type: string
          description: The setting id of abb that defined in setting page.
        audioKey:
          type: string
          description: 'The system-generated audio Key referring to the audio file for this message. '
        expires:
          type: string
          description: How long the message expires. This is in formatted in the ISO 8601 "duration" format.
          example: PT5H
    AlertUsSetting:
      type: object
      description: The rest alert us setting content
      required:
      - id
      - profileId
      properties:
        id:
          type: string
          description: The identity of alert us rest setting that pre-defined on alert us setting page.
        profileId:
          type: string
          description: The profile identity of alert us rest setting that pre-defined on alert us setting page..
        duration:
          type: string
          description: The duration of the message,This is in formatted in the ISO 8601 "duration" format.
          example: PT5H
        groupNames:
          type: array
          description: The group name of alert us.
          items:
            type: string
    ApiSettings:
      type: object
      description: Settings that adjust how the communication is sent to the recipients.
      properties:
        id:
          type: string
          description: An optional ID of a preexisting set of settings. If provided along with any other settings in this object, the settings are merged so that any settings defined in this request override those stored in the settings at the given ID.
        defaultLanguage:
          $ref: '#/components/schemas/SupportedLanguages'
        sender:
          $ref: '#/components/schemas/SenderSettings'
        delivery:
          $ref: '#/components/schemas/DeliverySettings'
        recipientInteraction:
          $ref: '#/components/schemas/RecipientSettings'
    ContactRecipientId:
      type: object
      description: Refers to a contact recipient by its contact ID.
      required:
      - type
      - id
      properties:
        type:
          type: string
          description: Must be set to exactly `Id`.
          enum:
          - Id
        id:
          type: string
          description: The contact ID from the [Everbridge Contacts API](https://developers.everbridge.net/internal/reference/ebs-list-contacts).
    TextOnlyPathCategory:
      type: string
      description: A group of contact path types that only support textual messaging.
      enum:
      - CATEGORY:BUSINESSMESSAGINGAPPS
      - CATEGORY:COMMON
      - CATEGORY:EMAIL
      - CATEGORY:MOBILEAPP
      - CATEGORY:PLAINTEXT
      - CATEGORY:SMS
    ApiDeliveryPathPrompt:
      type: object
      description: The unique description, provided by the organization, for the delivery path.
      required:
      - type
      - prompt
      properties:
        type:
          type: string
          description: Must be set to exactly `Prompt`.
          enum:
          - Prompt
        prompt:
          type: string
          description: The unique description, provided by the organization, for the delivery path.
    WebPageMessageBody:
      allOf:
      - $ref: '#/components/schemas/LaunchMessageBody'
      - type: object
        description: ''
        required:
        - type
        - content
        - paths
        properties:
          attachments:
            type: array
            description: A set of system-generated IDs representing previously uploaded attachments. Note that attachments are aggregated across all message bodies (i.e. every message body gets the same attachments).
            items:
              type: string
          type:
            type: string
            description: A generic classifier of the message body, further refined by `contentType`. Must be set to exactly `WebPage`.
            enum:
            - WebPage
          content:
            type: string
            description: Text content to use as the body of the web page.
          paths:
            type: array
            description: A set of contact delivery path types or path categories that this message body should be sent to.
            items:
              type: string
              enum:
              - CATEGORY:SMS
          usePrefix:
            type: boolean
            description: If set to true, will prefix the message with organization-specific text prior to including the web page URL. Defaults to false.
          additionalContent:
            type: string
            description: Optional additional plain text content to send with the initial message. Not included in the web page.
    GroupRecipientId:
      type: object
      description: Refers to a group of contact recipients by a group ID.
      required:
      - type
      - id
      properties:
        type:
          type: string
          description: Must be set to exactly `Id`.
          enum:
          - Id
        id:
          type: string
          description: The contact group ID from the [Everbridge Groups API](https://developers.everbridge.net/internal/reference/ebs-list-groups).
    Facebook:
      type: object
      description: The Facebook custom message content.
      properties:
        body:
          type: string
          description: The core content sent to facebook.
        imageId:
          type: string
          description: The system-generated image ID referring to the image file that will be sent to facebook
        image:
          $ref: '#/components/schemas/ContentAttachment'
    PublicMessagePermission:
      type: object
      properties:
        webWidget:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        alertUs:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        genericOneWay:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        audioBulletinBoard:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        memberPortal:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        network:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
        socialMedia:
          type: string
          enum:
          - NONE
          - VIEW
          - EDIT
          - ADD_REMOVE
          description: 'Controls how users can interact with this part of the template when launching a communication:

            - `NONE` or `VIEW`: Users can use this data but cannot modify it.

            - `EDIT`: Users can modify this data.

            - `ADD_REMOVE`: Users can add or remove this data.'
    LaunchMessageBody:
      type: object
      required:
      - contentType
      - title
      properties:
        contentType:
          type: string
          description: "A MIME type, defined in IETF's [RFC 6838](https://datatracker.ietf.org/doc/html/rfc6838), that describes the content type (e.g. `text/plain` for plain text or `audio/ogg` for an audio file). The content types that are valid for a given message body depends on the `type` of the message body:\n * `AudioMessageBody`: Supports only `audio` MIME types with any of its supported contact delivery path types.\n * `TextualMessageBody`: Supports only `text` MIME types with any of its supported contact delivery path types; for audio-only contact delivery path types, the text content will be translated to spoken audio via text-to-speech.\n * `WebPageMessageBody`: Supports only `text` MIME types with any of its supported contact delivery path types."
        title:
          type: string
          description: A title for the notification. For audio messages, this is used for display purposes within the Everbridge portal.
          minLength: 1
          maxLength: 255
    SemanticQuery:
      allOf:
      - $ref: '#/components/schemas/Command'
      description: A query use for generating a CEM Result built with semantic logic
      type: object
      properties:
        type:
          type: string
          description: The type of command to execute
          enum:
          - SemanticQuery
        inArea:
          $ref: '#/components/schemas/Geometry'
        starting:
          type: string
          format: date-time
          description: Optional start time for bounding the query. Affects some locations and travel itineraries.
        ending:
          type: string
          format: date-time
          description: Optional end time for bounding the query. Affects some locations and travel itineraries.
        ofTypeIds:
          type: array
          items:
            type: string
          description: A list of contact or asset type IDs to filter the results by.
        tagged:
          type: array
          items:
            type: string
          description: A list of tags to filter the results by.
        inPropertyIds:
          type: array
          items:
            type: string
          description: A list of property IDs to filter the results by.
        withProperties:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/CemResultsBooleanPropertyQuery'
            - $ref: '#/components/schemas/CemResultsNumberPropertyQuery'
            - $ref: '#/components/schemas/CemResultsStringPropertyQuery'
          description: A list of property IDs to filter the results by.
        named:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/CemResultsCompleteName'
          description: A list of names to filter the results by.
        identified:
          type: array
          items:
            type: string
          description: A list of identifiers to filter the results by.
        memberOfIds:
          type: array
          items:
            type: number
          description: A list of groups IDs to find members of.
        withLocationTypes:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/CemResultsStaticLocationType'
            - $ref: '#/components/schemas/CemResultsLastKnownLocationType'
            - $ref: '#/components/schemas/CemResultsExpectedLocationType'
            - $ref: '#/components/schemas/CemResultsTravelLocationType'
          description: A list of location types to filter the results by.
        ofRuleIds:
          type: array
          items:
            type: number
          description: A list of rules to filter the results by.
        isExpatriate:
          type: boolean
          description: If true, include expatriates in the results for contact result sets.
        isVip:
          type: boolean
          description: If true, include VIPs in the results for contact result sets.
        subscribedToIds:
          type: array
          items:
            type: string
          description: A list of public feed IDs to retrieve subscribers for. Only applicable to `publicuser` result sets.
        forZipCodes:
          type: array
          items:
            type: string
          description: A list of zipcodes to filter subscribers. Only applicable to `publicuser` result set.
        sendToAorSubscriptions:
          type: boolean
          description: If true, include org area-of-responsibility subscriptions. Only applicable to `publicuser` result set.
    ApiDeliveryPath:
      description: Delivery paths are ordered methods of contacting recipients, such as "work email" or "home phone".
      anyOf:
      - $ref: '#/components/schemas/ApiDeliveryPathPathId'
      - $ref: '#/components/schemas/ApiDeliveryPathPrompt'
    NetworkPublicMessage:
      type: object
      description: The Network public message content.
      required:
      - body
      - networkEffectTypes
      - affectedAreas
      - groupIds
      properties:
        body:
          type: string
          description: The core content of network.
        networkEffectTypes:
          type: array
          description: ' The type of network effect'
          items:
            type: string
          enum:
          - PUBLIC
          - NETWORK_GROUP
        affectedAreas:
          type: string
          description: The shape content.
        groupIds:
          type: array
          description: The  groupIds defined in network setting page.
          items:
            type: string
    CemResultsStaticLocationType:
      type: object
      description: Specifies how to include contacts with static location types in CEM Results.
      required:
      - type
      properties:
        type:
          type: string
          description: Must be set to exactly `Static`.
          enum:
          - Static
        locationTypeIds:
          type: array
          description: A list of static location type IDs.
          items:
            type: number
        includeMissingLocationTypeId:
          type: boolean
          description: If true, include results that do not have a static location type.
    MemberPortalPublicMessage:
      type: object
      description: The member portal public message content.
      required:
      - body
      - includeSelectedMapShape
      properties:
        body:
          type: string
          description: The core content that displayed on public member public message  page.
        includeSelectedMapShape:
          type: boolean
          description: 'Whether include the map defined in recipient part  '
    ContentAttachment:
      type: object
      properties:
        fileId:
          type: string
        fileName:
          type: string
        mimeType:
          type: string
        downloadUrl:
          type: string
        size:
          type: integer
          format: int64
    AudioMessageBody:
      allOf:
      - $ref: '#/components/schemas/LaunchMessageBody'
      - type: object
        required:
        - type
        - attachmentId
        - paths
        properties:
          attachmentId:
            type: string
            description: The system-generated attachment ID referring to the audio file for this message.
          type:
            type: string
            description: A generic classifier of the message body, further refined by `contentType`. Must be set to exactly `Audio`.
            enum:
            - Audio
          paths:
            type: array
            description: A set of contact delivery path types that this message body should be sent to.
            items:
              $ref: '#/components/schemas/AudioOnlyPathCategory'
    RuleRecipientId:
      type: object
      description: Refers to a group of contact rules (filters) by an ID. Retrieve contact rule IDs using the [Everbridge Contact Filters API](https://developers.everbridge.net/internal/reference/ebs-v1-contact-filters)
      required:
      - type
      - id
      properties:
        type:
          type: string
          description: Must be set to exactly `Id`.
          enum:
          - Id
        id:
          type: string
          description: The contact rule (filter) ID.
    Command:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          description: The type of command to execute
    SenderSettings:
      type: object
      description: Specify what recipients will see as the "sender" of the notifications sent from the communication (e.g. caller ID upon receiving a phone call.)
      properties:
        email:
          type: object
          description: Configuration elements that control the display of the sender in email notifications.
          properties:
            name:
              type: string
              description: The display name used in email notifications.
            replyToEmail:
              type: string
              description: The "reply to" email address to use for email notifications.
        voice:
          type: array
          description: Configuration elements that control the display of the caller in phone call notifications.
          items:
            $ref: '#/components/schemas/VoiceSettings'
        sms:
          type: array
          description: Configuration elements that control the display of the sender in SMS notifications.
          items:
            $ref: '#/components/schemas/SmsSettings'
    SmsSettings:
      type: object
      description: The SMS short code or phone number shown to recipients of text messages.
      required:
      - countryCode
      - smsId
      properties:
        countryCode:
          type: string
          description: The ISO 3166 two-letter code for the country where this phone number is valid. Please refer to [the Wikipedia page on ISO 3166 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) for valid values.
        smsId:
          type: string
          description: The SMS ID to use when sending SMS messages to recipients residing in the country specified by `countryCode`.
          pattern: '^[a-zA-Z0-9]+(?: [a-zA-Z0-9]+)?$'
          minLength: 1
          maxLength: 11
    DeliverySettings:
      type: object
      description: Settings that adjust the way that notifications are delivered to recipients.
      properties:
        paths:
          type: array
          description: A list of contact delivery paths to use in notifying recipients. Refer to the [Everbridge List Contact Paths API](https://developers.everbridge.net/internal/reference/ebs-list-contact-paths) to find contact delivery paths for an organization.
          items:
            $ref: '#/components/schemas/ApiDeliveryPath'
        pathOrder:
          type: string
          description: Determines which ordering of delivery paths are used for this notification.
          enum:
          - CONTACT
          - ORGANIZATION
          - CUSTOM
        ttl:
          type: string
          description: "The amount of time, beginning at the communicati

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/everbridge/refs/heads/main/openapi/everbridge-template-category-apis-api-openapi.yml