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

# Register conversion

> Register a conversion linked to a short link.



## OpenAPI

````yaml /en/short-links-api/api-reference/openapi-conversions.json post /v1/conversions
openapi: 3.0.3
info:
  title: Notifique API. Conversions (Smart Links)
  description: >-
    Register **conversions** or orders attributed to a message sent via
    Notifique.


    **Authentication:** `Authorization: Bearer sk_live_xxxxx` or `x-api-key`.


    **Scope:** `conversions:manage`.


    Use the tracked message `msg_id` (Smart Link / automatic link on send). The
    operation is **idempotent** per `order_id`, repeating the same order returns
    **200** instead of duplicating.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfConversionsBearerAuth: []
  - ntfConversionsApiKeyHeader: []
tags:
  - name: Conversions
    description: Order attribution to tracked messages (`POST /v1/conversions`).
paths:
  /v1/conversions:
    post:
      tags:
        - Conversions
      summary: Register conversion
      description: Register a conversion linked to a short link.
      operationId: ntfConversions_postV1Conversions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - msg_id
                - order_id
              properties:
                msg_id:
                  type: string
                  maxLength: 128
                  description: Notifique message ID tied to the click (Smart Link).
                order_id:
                  type: string
                  maxLength: 256
                  description: Unique order ID in your system.
                value:
                  type: number
                  description: Amount in currency units (e.g. 149.90).
                valueCents:
                  type: integer
                  description: Amount in cents (alternative to `value`).
                currency:
                  type: string
                  default: BRL
                metadata:
                  type: object
                  additionalProperties: true
            example:
              msg_id: msg_abc123
              order_id: ORD-98765
              value: 149.9
              currency: BRL
      responses:
        '200':
          description: Conversion already existed (idempotent).
        '201':
          description: Conversion created.
        '400':
          description: Invalid body.
        '401':
          description: Unauthorized.
        '403':
          description: Missing `conversions:manage` scope.
components:
  securitySchemes:
    ntfConversionsBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key in Authorization header. Example: `Authorization: Bearer
        sk_live_xxxxx`
    ntfConversionsApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key in x-api-key header.

````