> ## Documentation Index
> Fetch the complete documentation index at: https://help.lobyco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create push notification.

> Accepts a request body containing all the necessary details for the push notification.



## OpenAPI

````yaml openapi/push-v1.json POST /v1/Notification
openapi: 3.0.1
info:
  title: Push.Api
  version: v1
servers:
  - url: https://{host}/push
    description: Your Lobyco environment
    variables:
      host:
        default: your-environment.lobyco.net
        description: >-
          The API host for your Lobyco environment. Replace it with the host you
          were given — this placeholder does not resolve.
security:
  - Bearer: []
paths:
  /v1/Notification:
    post:
      tags:
        - S2S
      summary: Create push notification.
      description: >-
        Accepts a request body containing all the necessary details for the push
        notification.
      requestBody:
        description: >-
          The payload containing the information required to create a push
          notification.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationRequestV2'
          application/json:
            schema:
              $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationRequestV2'
          text/json:
            schema:
              $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationRequestV2'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationRequestV2'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Push.Api.DTO.CreateNotificationResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
components:
  schemas:
    Push.Api.DTO.CreateNotificationRequestV2:
      required:
        - deliveryDate
        - isReadyToDistribute
        - message
        - title
      type: object
      properties:
        title:
          maxLength: 255
          minLength: 1
          type: string
          description: Title of the push notification.
        name:
          maxLength: 255
          type: string
          description: >-
            Optional name of the push activity. If not provided, the title is
            used as the activity name.
          nullable: true
        message:
          maxLength: 256
          minLength: 1
          type: string
          description: Message content of the push notification.
        deepLink:
          $ref: '#/components/schemas/Push.Api.DTO.DeepLink'
        deliveryDate:
          type: string
          description: >-
            The scheduled delivery date of the push notification. Required if
            IsReadyToDistribute is set to true.
          format: date-time
        expirationDate:
          type: string
          description: >-
            Expiration date after which the notifications will no longer be
            sent.
          format: date-time
          nullable: true
        isSegmented:
          type: boolean
          description: >-
            Obsolete. Indicates if the notification is segmented. Use
            Push.Api.DTO.CreateNotificationRequest.SegmentationType instead.
          nullable: true
          deprecated: true
        segmentationType:
          $ref: '#/components/schemas/Push.Domain.SegmentationType'
        isReadyToDistribute:
          type: boolean
          description: Indicates whether the notification is ready to be distributed.
        audienceIds:
          type: array
          items:
            type: string
          description: List of audience IDs targeted by the notification.
          nullable: true
        storeId:
          type: string
          description: Identifier for store targeted by the notification
          nullable: true
        unifiedCampaignId:
          type: string
          description: Unified campaign identifier
          nullable: true
        externalId:
          type: string
          description: External identifier of the notification.
          nullable: true
        externalUrl:
          type: string
          description: External URL linked to the content or notification.
          nullable: true
        authorId:
          type: string
          description: Identifier of the author who created the content or notification.
          nullable: true
        authorName:
          type: string
          description: Name of the author who created the content or notification.
          nullable: true
        isPrivate:
          type: boolean
          description: >-
            Indicates whether the content or notification is private (restricted
            access).
      additionalProperties: false
    Push.Api.DTO.CreateNotificationResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    Push.Api.DTO.DeepLink:
      type: object
      properties:
        id:
          maxLength: 125
          type: string
          description: >-
            Deep link identifier. Used to open a specific page from the
            application.
          nullable: true
        parameters:
          type: object
          additionalProperties:
            type: string
          description: >-
            Additional parameters for deep link. (e.g. redirect user to a
            specific entity from the page configured with DeepLinkId)
          nullable: true
        url:
          maxLength: 2047
          type: string
          description: Deep link URL for navigation.
          nullable: true
      additionalProperties: false
    Push.Domain.SegmentationType:
      enum:
        - 0
        - 1
        - 2
        - 3
      type: integer
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: >-
        Opaque Authorization header using the Bearer scheme. Example:
        "Authorization: Bearer {token}"
      name: Authorization
      in: header

````