> ## 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.

# Crear contacto

> Registra un nuevo contacto.



## OpenAPI

````yaml /es/contacts-api/api-reference/openapi-contacts.json post /v1/contacts
openapi: 3.0.3
info:
  title: Notificar contactos API, etiquetas y audiencia
  description: >-
    API para **CRUD de contactos**, **etiquetas**, **temas**, **segmentos** y
    **campañas** (plantilla + audiencia + canales).


    **Contacto:** al menos uno de los **teléfono** o **correo electrónico**
    (único por espacio de trabajo). **Idiomas:** `languages` es una serie de
    códigos BCP-47 permitidos (enumerados en **`GET
    /v1/meta/contact-locales`**); orden = prioridad. **Telegram:** use
    **`telegramLinks`** (`instanceId` + `peer`) para múltiples instancias de
    Telegram en el mismo espacio de trabajo; **`telegramPeer`** permanece como
    un acceso directo heredado (rellena el enlace en la **instancia
    predeterminada de Telegram** del espacio de trabajo). En la campaña, el par
    utilizado es el de **`telegramInstanceId`** de la campaña (o
    predeterminado), con *respaldo* a `telegramPeer`.


    **Campañas:** `channels` puede incluir `whatsapp`, `sms`, `email`,
    `telegram`. Cada canal enumerado debe estar **habilitado en la plantilla**.
    **`instanceId`** = WhatsApp; **`telegramInstanceId`** = Telegrama.


    **Tarjeta WhatsApp:** `POST /v1/whatsapp/messages` con `type: "contact"` y
    `payload.contactId`.


    **Autenticación:** `Authorization: Bearer sk_live_xxxxx` o `x-api-key`.


    **Alcances:** `contacts:*`, `tags:*`, `topics:*`, `segments:*`,
    `campaigns:*` (incluye `campaigns:run`).


    **Extras de campaña:** `POST .../cancel` (BORRADOR/PROGRAMADO), `GET
    .../stats` y `GET .../recipients` (actualización/lectura de alcances).
    Ejecutar devuelve `runId`. Grupo de envío de WhatsApp: panel de control.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfContactBearerAuth: []
  - ntfContactApiKeyHeader: []
tags:
  - name: Contatos
    description: >-
      CRUD de contactos del espacio de trabajo (teléfono o correo electrónico;
      etiquetas)
  - name: Tags
    description: Tags (etiquetas) para vincular a contactos
  - name: Temas
    description: Temas de comunicación (marketing/inscripción por tema)
  - name: Segmentos
    description: >-
      Segmentos de audiencia (DSL v1). Reglas: etiqueta, propiedad, campo de
      contacto, tema, recibirMarketing. Segmentos de ámbitos:
      leer|crear|actualizar|eliminar.
  - name: Campanhas
    description: Campañas multicanal con plantilla; ejecución vía POST .../ejecutar
paths:
  /v1/contacts:
    post:
      tags:
        - Contatos
      summary: Crear contacto
      description: Registra un nuevo contacto.
      operationId: ntfContact_postV1Contacts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfContact_ContactCreate'
      responses:
        '200':
          description: Contacto creado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/NtfContact_Contact'
        '400':
          description: >-
            Número de teléfono no válido o ausencia de teléfono/correo
            electrónico (CONTACT_REQUIRES_PHONE_OR_EMAIL) o identificadores de
            etiqueta no válidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '401':
          description: No autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '402':
          description: Plan vencido o suspendido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '403':
          description: 'Contactos faltantes: crear alcance.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '409':
          description: >-
            Teléfono o correo electrónico no existe ningún espacio de trabajo
            (CONTACT_PHONE_EXISTS, CONTACT_EMAIL_EXISTS).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
components:
  schemas:
    NtfContact_ContactCreate:
      type: object
      description: >-
        Se requiere al menos un **teléfono** o **correo electrónico**.
        **telegramLinks** o **telegramPeer** (instancia predeterminada).
        **idiomas** opcional (códigos de GET /v1/meta/contact-locales).
      properties:
        phone:
          type: string
          nullable: true
          description: Teléfono (único por espacio de trabajo)
        email:
          type: string
          nullable: true
          description: Correo electrónico (único por espacio de trabajo)
        name:
          type: string
          nullable: true
        telegramPeer:
          type: string
          nullable: true
          maxLength: 128
          description: >-
            Legacy: chat_id o @username en la instancia predeterminada de
            Telegram. Se ignora si se envía **telegramLinks**.
        telegramLinks:
          type: array
          items:
            type: object
            required:
              - instanceId
              - peer
            properties:
              instanceId:
                type: string
              peer:
                type: string
                maxLength: 128
          description: >-
            Una entrada por instancia de Telegram; par único por (instanceId,
            par) en el espacio de trabajo.
        languages:
          type: array
          items:
            type: string
          description: Reemplaza la lista de idiomas (se permite vacío).
        url:
          type: string
          nullable: true
        tagIds:
          type: array
          items:
            type: string
          description: IDs das etiquetas a vincular
        receiveMarketing:
          type: boolean
    NtfContact_Contact:
      type: object
      description: >-
        Contacto del espacio de trabajo (teléfono y/o correo electrónico;
        etiquetas). **telegramLinks** por instancia de Telegram;
        **telegramPeer** refleja el par en la instancia predeterminada
        (heredada).
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
          description: Teléfono con código de país
        email:
          type: string
          nullable: true
        telegramPeer:
          type: string
          nullable: true
          description: >-
            Espejo de pares en la instancia predeterminada de Telegram; Prefiere
            TelegramLinks para múltiples conexiones.
        languages:
          type: array
          items:
            type: string
          description: Se permiten códigos BCP-47; orden = prioridad de idioma preferido.
        receiveMarketing:
          type: boolean
        telegramLinks:
          type: array
          items:
            $ref: '#/components/schemas/NtfContact_TelegramLink'
        url:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        tags:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
    NtfContact_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: >-
            Etiqueta de error de estilo HTTP (por ejemplo, no autorizado,
            solicitud incorrecta, no encontrada).
        message:
          type: string
          description: >-
            Mensaje legible por humanos para usuarios finales (localizado a
            través de Accept-Language/x-locale cuando corresponda).
        code:
          type: string
          description: >-
            Código API v1 estable (enumeración). Siempre presente en los
            errores. Úselo con el estado HTTP para decidir reintentar o
            corregir. Ver [Respuestas de
            error](/es/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfContact_TelegramLink:
      type: object
      description: Vincular el contacto a una instancia de Telegram del espacio de trabajo.
      properties:
        instanceId:
          type: string
        peer:
          type: string
          description: chat_id o @username en este caso
        instanceName:
          type: string
          description: Nombre de instancia (conexión)
  securitySchemes:
    ntfContactBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Autorización: Portador sk_live_xxxxx'
    ntfContactApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-clave: sk_live_xxxxx'

````