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

# Replace the order-status notification rules for a store connection

**Required scope:** `crm.edit`


## OpenAPI

````yaml /api-reference/openapi.json put /crm/connections/{id}/order-notifications
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /crm/connections/{id}/order-notifications:
    put:
      summary: Replace the order-status notification rules for a store connection
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  type: array
                  items:
                    type: object
                    properties:
                      trigger:
                        type: string
                        enum:
                          - ORDER_PLACED
                          - ORDER_PAID
                          - ORDER_PARTIALLY_FULFILLED
                          - ORDER_SHIPPED
                          - ORDER_OUT_FOR_DELIVERY
                          - ORDER_DELIVERED
                          - ORDER_CANCELLED
                          - ORDER_REFUNDED
                      templateId:
                        type: string
                        minLength: 1
                      presetId:
                        type: string
                        minLength: 1
                      enabled:
                        type: boolean
                        default: true
                      delayMinutes:
                        type: integer
                        minimum: 0
                        maximum: 20160
                        default: 0
                    required:
                      - trigger
                  maxItems: 16
              required:
                - rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        trigger:
                          type: string
                          enum:
                            - ORDER_PLACED
                            - ORDER_PAID
                            - ORDER_PARTIALLY_FULFILLED
                            - ORDER_SHIPPED
                            - ORDER_OUT_FOR_DELIVERY
                            - ORDER_DELIVERED
                            - ORDER_CANCELLED
                            - ORDER_REFUNDED
                        templateId:
                          type: string
                        enabled:
                          type: boolean
                        delayMinutes:
                          type: integer
                          minimum: 0
                          maximum: 20160
                        templateStatus:
                          type: string
                        templatePurpose:
                          type: string
                      required:
                        - id
                        - trigger
                        - templateId
                        - enabled
                        - delayMinutes
                        - templateStatus
                        - templatePurpose
                  recentOrderVolume:
                    type: integer
                    minimum: 0
                required:
                  - rules
                  - recentOrderVolume
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `template_not_found`: Template id not in this workspace (400 in
            order-notification rules).

            - `template_or_preset_required`: Order-notification rule has neither
            template nor preset.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `crm_connection_not_found`: CRM connection not found (400 on
            campaign create: missing or not ACTIVE; 404 on CRM routes).

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.