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

# Submeter instância para provisionamento

> Valida o perfil completo e envia para aprovação. Pode retornar `standby: true` enquanto aguarda revisão manual.



## OpenAPI

````yaml /es/rcs-api/api-reference/openapi-rcs.json post /v1/rcs/instances/{instanceId}/submit
openapi: 3.0.3
info:
  title: API RCS de Notifique
  description: >-
    Envíe mensajes RCS, gestione agentes (instancias) y consulte respuestas
    recibidas. Autentique com `Authorization: Bearer sk_live_...` ou
    `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfRcsBearerAuth: []
  - ntfRcsApiKeyHeader: []
tags:
  - name: Mensagens
    description: Envío, listado, consulta y cancelación de mensajes RCS salientes.
  - name: Instâncias
    description: >-
      Agentes RCS de marca del workspace: creación, revisión y
      aprovisionamiento.
  - name: Inbound
    description: Mensajes RCS recibidos (MO) en el workspace.
paths:
  /v1/rcs/instances/{instanceId}/submit:
    post:
      tags:
        - Instâncias
      summary: Submeter instância para provisionamento
      description: >-
        Valida o perfil completo e envia para aprovação. Pode retornar `standby:
        true` enquanto aguarda revisão manual.
      operationId: ntfRcs_postV1RcsInstanceSubmit
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Submissão aceita.
          content:
            application/json:
              examples:
                active:
                  summary: Agente activo
                  value:
                    success: true
                    data:
                      id: inst_rcs_abc123
                      name: Minha Marca RCS
                      status: ACTIVE
                      slug: minha-marca
                      displayName: Minha Marca
                      connectionKind: comtele
                      onboardingStatus: ACTIVE
                      onboardingError: null
                      googleAgentId: null
                      agentProfile:
                        brandName: Minha Marca
                        displayName: Minha Marca
                        hostingRegion: NORTH_AMERICA
                        billingCategory: NON_CONVERSATIONAL
                        agentUseCase: PROMOTIONAL
                        description: Campanhas e avisos promocionais da Minha Marca.
                        color: '#1A73E8'
                        logoUri: https://cdn.example.com/rcs/logo.png
                        heroUri: https://cdn.example.com/rcs/hero.png
                        phoneNumbers:
                          - value: '+551140028922'
                            label: SAC
                        emails:
                          - value: contato@minhamarca.com
                            label: Suporte
                        websites:
                          - uri: https://minhamarca.com
                            label: Site
                        privacy:
                          uri: https://minhamarca.com/privacidade
                        termsConditions:
                          uri: https://minhamarca.com/termos
                        brandContactName: Maria Silva
                        brandContactEmailAddress: maria@minhamarca.com
                        brandWebsiteUrl: https://minhamarca.com
                        attachments: []
                        brazil:
                          cnpj: '12345678000199'
                          legalName: Minha Marca LTDA
                          brandAuthorizationAccepted: true
                        launch:
                          contacts:
                            - name: Maria Silva
                              title: Marketing
                              email: maria@minhamarca.com
                          triggerDescription: Cliente recebe RCS após opt-in no site.
                          interactionsDescription: Botões de resposta e links para landing pages.
                          optoutDescription: Responda SAIR para cancelar.
                          agentAccessInstructions: Acesse pelo app Mensagens do Android.
                      pendingDisplayName: null
                      pendingAgentProfile: null
                      revisionStatus: NONE
                      revisionSubmittedAt: null
                      revisionRejectedAt: null
                      revisionRejectionReason: null
                      submittedAt: null
                      createdAt: '2025-02-10T10:00:00.000Z'
                      updatedAt: '2025-02-10T10:00:00.000Z'
                      awaitingPartner: false
                      revisionAwaitingPartner: false
                    standby: false
                    message: null
                standby:
                  summary: En espera de revisión
                  value:
                    success: true
                    data:
                      id: inst_rcs_abc123
                      name: Minha Marca RCS
                      status: PENDING
                      slug: minha-marca
                      displayName: Minha Marca
                      connectionKind: comtele
                      onboardingStatus: SUBMITTED
                      onboardingError: null
                      googleAgentId: null
                      agentProfile:
                        brandName: Minha Marca
                        displayName: Minha Marca
                        hostingRegion: NORTH_AMERICA
                        billingCategory: NON_CONVERSATIONAL
                        agentUseCase: PROMOTIONAL
                        description: Campanhas e avisos promocionais da Minha Marca.
                        color: '#1A73E8'
                        logoUri: https://cdn.example.com/rcs/logo.png
                        heroUri: https://cdn.example.com/rcs/hero.png
                        phoneNumbers:
                          - value: '+551140028922'
                            label: SAC
                        emails:
                          - value: contato@minhamarca.com
                            label: Suporte
                        websites:
                          - uri: https://minhamarca.com
                            label: Site
                        privacy:
                          uri: https://minhamarca.com/privacidade
                        termsConditions:
                          uri: https://minhamarca.com/termos
                        brandContactName: Maria Silva
                        brandContactEmailAddress: maria@minhamarca.com
                        brandWebsiteUrl: https://minhamarca.com
                        attachments: []
                        brazil:
                          cnpj: '12345678000199'
                          legalName: Minha Marca LTDA
                          brandAuthorizationAccepted: true
                        launch:
                          contacts:
                            - name: Maria Silva
                              title: Marketing
                              email: maria@minhamarca.com
                          triggerDescription: Cliente recebe RCS após opt-in no site.
                          interactionsDescription: Botões de resposta e links para landing pages.
                          optoutDescription: Responda SAIR para cancelar.
                          agentAccessInstructions: Acesse pelo app Mensagens do Android.
                      pendingDisplayName: null
                      pendingAgentProfile: null
                      revisionStatus: NONE
                      revisionSubmittedAt: null
                      revisionRejectedAt: null
                      revisionRejectionReason: null
                      submittedAt: null
                      createdAt: '2025-02-10T10:00:00.000Z'
                      updatedAt: '2025-02-10T10:00:00.000Z'
                      awaitingPartner: true
                      revisionAwaitingPartner: false
                    standby: true
                    message: Agent submitted for manual review.
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/NtfRcs_RcsInstancePublic'
                  standby:
                    type: boolean
                  message:
                    type: string
                    nullable: true
        '400':
          description: Perfil incompleto (`RCS_PROFILE_INCOMPLETE`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Bad Request
                message: Agent profile is incomplete
                code: RCS_PROFILE_INCOMPLETE
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Unauthorized
                message: Invalid or missing API Key
                code: UNAUTHORIZED
        '403':
          description: API Key sem acesso a esta instância.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Forbidden
                message: Access to this instance is not allowed by this API Key
                code: FORBIDDEN
        '404':
          description: Instância não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Not Found
                message: RCS instance not found
                code: NOT_FOUND
        '409':
          description: Agente já ativo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Conflict
                message: RCS instance is already active
                code: RCS_ALREADY_ACTIVE
components:
  schemas:
    NtfRcs_RcsInstancePublic:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - DISCONNECTED
            - SUSPENDED
        slug:
          type: string
        displayName:
          type: string
        connectionKind:
          type: string
        onboardingStatus:
          type: string
          enum:
            - DRAFT
            - SUBMITTED
            - VERIFICATION_PENDING
            - LAUNCH_PENDING
            - ACTIVE
            - REJECTED
        onboardingError:
          type: string
          nullable: true
        googleAgentId:
          type: string
          nullable: true
        agentProfile:
          type: object
          properties:
            brandName:
              type: string
              example: Minha Marca
            displayName:
              type: string
              example: Minha Marca
            hostingRegion:
              type: string
              example: NORTH_AMERICA
            billingCategory:
              type: string
              example: NON_CONVERSATIONAL
            agentUseCase:
              type: string
              example: PROMOTIONAL
            description:
              type: string
              example: Campanhas e avisos promocionais da Minha Marca.
            color:
              type: string
              example: '#1A73E8'
            logoUri:
              type: string
              example: https://cdn.example.com/rcs/logo.png
            heroUri:
              type: string
              example: https://cdn.example.com/rcs/hero.png
            phoneNumbers:
              type: array
              items:
                type: string
              example:
                - value: '+551140028922'
                  label: SAC
            emails:
              type: array
              items:
                type: string
              example:
                - value: contato@minhamarca.com
                  label: Suporte
            websites:
              type: array
              items:
                type: string
              example:
                - uri: https://minhamarca.com
                  label: Site
            privacy:
              type: object
              additionalProperties: true
              example:
                uri: https://minhamarca.com/privacidade
              properties:
                uri:
                  type: string
                  example: https://minhamarca.com/privacidade
            termsConditions:
              type: object
              additionalProperties: true
              example:
                uri: https://minhamarca.com/termos
              properties:
                uri:
                  type: string
                  example: https://minhamarca.com/termos
            brandContactName:
              type: string
              example: Maria Silva
            brandContactEmailAddress:
              type: string
              example: maria@minhamarca.com
            brandWebsiteUrl:
              type: string
              example: https://minhamarca.com
            attachments:
              type: array
              items:
                type: string
              example: []
            brazil:
              type: object
              additionalProperties: true
              example:
                cnpj: '12345678000199'
                legalName: Minha Marca LTDA
                brandAuthorizationAccepted: true
              properties:
                cnpj:
                  type: string
                  example: '12345678000199'
                legalName:
                  type: string
                  example: Minha Marca LTDA
                brandAuthorizationAccepted:
                  type: boolean
                  example: true
            launch:
              type: object
              additionalProperties: true
              example:
                contacts:
                  - name: Maria Silva
                    title: Marketing
                    email: maria@minhamarca.com
                triggerDescription: Cliente recebe RCS após opt-in no site.
                interactionsDescription: Botões de resposta e links para landing pages.
                optoutDescription: Responda SAIR para cancelar.
                agentAccessInstructions: Acesse pelo app Mensagens do Android.
              properties:
                contacts:
                  type: array
                  items:
                    type: string
                  example:
                    - name: Maria Silva
                      title: Marketing
                      email: maria@minhamarca.com
                triggerDescription:
                  type: string
                  example: Cliente recebe RCS após opt-in no site.
                interactionsDescription:
                  type: string
                  example: Botões de resposta e links para landing pages.
                optoutDescription:
                  type: string
                  example: Responda SAIR para cancelar.
                agentAccessInstructions:
                  type: string
                  example: Acesse pelo app Mensagens do Android.
        pendingDisplayName:
          type: string
          nullable: true
        pendingAgentProfile:
          type: object
          nullable: true
        revisionStatus:
          type: string
          enum:
            - NONE
            - DRAFT
            - SUBMITTED
            - VERIFICATION_PENDING
            - LAUNCH_PENDING
            - REJECTED
        revisionSubmittedAt:
          type: string
          format: date-time
          nullable: true
        revisionRejectedAt:
          type: string
          format: date-time
          nullable: true
        revisionRejectionReason:
          type: string
          nullable: true
        submittedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        awaitingPartner:
          type: boolean
        revisionAwaitingPartner:
          type: boolean
      example:
        id: clxx...
        name: Exemplo
        status: PENDING
        slug: string
        displayName: string
        connectionKind: string
        onboardingStatus: DRAFT
        onboardingError: string
        googleAgentId: clxx...
        agentProfile: {}
        pendingDisplayName: string
        pendingAgentProfile: {}
        revisionStatus: NONE
        revisionSubmittedAt: '2025-02-10T14:00:00.000Z'
        revisionRejectedAt: '2025-02-10T14:00:00.000Z'
        revisionRejectionReason: string
        submittedAt: '2025-02-10T14:00:00.000Z'
        createdAt: '2025-02-10T14:00:00.000Z'
        updatedAt: '2025-02-10T14:00:00.000Z'
        awaitingPartner: true
        revisionAwaitingPartner: true
    NtfRcs_ErrorResponse:
      type: object
      required:
        - success
        - error
        - message
        - code
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        data:
          type: object
          additionalProperties: true
          properties:
            status:
              type: string
              example: SENT
      example:
        success: false
        error: string
        message: string
        code: string
        details:
          - field: string
            message: string
        data: {}
  securitySchemes:
    ntfRcsBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfRcsApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`'

````